com.sas.cas.actions.builtins

Class HelpOptions

java.lang.Object

com.sas.cas.CASActionOptions

com.sas.cas.CASGeneratedActionOptions

com.sas.cas.actions.builtins.HelpOptions

All Implemented Interfaces:

KeyedMap<java.lang.String,java.lang.Object>, java.io.Serializable, java.util.Map<java.lang.String,java.lang.Object>

public class HelpOptions
extends CASGeneratedActionOptions

Options for help: Shows the parameters for an action or lists all available actions.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.sas.cas.CASActionOptions

CASActionOptions.EnumValue, CASActionOptions.FORMAT

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ACTION_NAME
static java.lang.String	ACTION_SET_NAME
static java.lang.String	KEY_ACTION
static java.lang.String	KEY_ACTIONSET
static java.lang.String	KEY_VERBOSE

Fields inherited from class com.sas.cas.CASActionOptions

FLAGS_EXPAND_ARRAYS, FLAGS_IGNORE_DISPOSITION_ERROR, FLAGS_RETURN_RESULTS_ON_EXCEPTION, FLAGS_SKIP_ACTION_EVENTS, FLAGS_SKIP_RESULTS, HIDDEN_PASSWORD, JSON_NULL, LUA_NIL, PARAMETER_FLAG_ISPASSWORD, PARAMETER_FLAG_ISPATH, PARAMETER_FLAG_ISTABLENAME, PARAMETER_FLAG_ISVAR, PARAMETER_FLAG_REQUIRED, PYTHON_NULL, SERIALIZED_PREFIX

Constructor Summary

Constructors

Constructor and Description
HelpOptions()
HelpOptions(CASActionOptions options)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAction()
java.lang.String	getActionSet()
java.lang.Object	getServerDefaultValue(java.lang.String key) Gets the server default value, if known.
java.lang.Boolean	getVerbose()
HelpOptions	setAction(java.lang.String value) Sets the value of parameter 'action': specifies the name of the action for which you want help.
HelpOptions	setActionSet(java.lang.String value) Sets the value of parameter 'actionSet': specifies the name of the action set for which you want help.
HelpOptions	setVerbose(java.lang.Boolean value) Sets the value of parameter 'verbose': when set to True, provides more detail for each parameter.

Methods inherited from class com.sas.cas.CASActionOptions

addActionFlags, addParameterFlag, appendValue, checkForPasswords, clear, containsKey, containsValue, convertToEnumArray, copy, deserialize, entrySet, equals, findOptionsClass, findSetter, get, getActionFlags, getActionName, getActionResponseEventListener, getActionResultEventListener, getActionSetName, getCASClient, getClassName, getDebugOptions, getDispositionEventListener, getFullyQualifiedActionName, getLogEventListener, getLogMessage, getMessageOutputStream, getMessageTagHandler, getParameter, getParameterAsBoolean, getParameterAsByteArray, getParameterAsDouble, getParameterAsDoubleArray, getParameterAsInteger, getParameterAsIntegerArray, getParameterAsLong, getParameterAsLongArray, getParameterAsString, getParameterAsStringArray, getParameterFlags, getParameterIgnoreCase, getParameterIgnoreCase, getParameterKeys, getPerformanceEventListener, getPropertyKey, getSessionID, getUserProperty, getUserPropertyKeys, hashCode, invoke, isEmpty, isFlagSet, isMap, isParameterFlagSet, isPassword, isPath, isRequired, isTable, isVariable, keySet, put, putAll, putAllDeep, putDeep, putDeep, quoteIfNotNull, remove, removeParameter, set, setActionFlags, setActionName, setActionResponseEventListener, setActionResultEventListener, setActionSetName, setCASClient, setDebugOptions, setDispositionEventListener, setFullyQualifiedActionName, setLogEventListener, setLogMessage, setMessageOutputStream, setMessageTagHandler, setParameter, setPerformanceEventListener, setPropertyKey, setSessionID, setUserProperty, size, toCASLString, toLuaString, toLuaString, toOptionsWithGeneratedClasses, toSerialized, toString, toString, toString, upcaseFirstChar, values

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Field Detail

ACTION_SET_NAME

public static final java.lang.String ACTION_SET_NAME

See Also:

Constant Field Values

ACTION_NAME

public static final java.lang.String ACTION_NAME

See Also:

Constant Field Values

KEY_ACTION

public static final java.lang.String KEY_ACTION

See Also:

Constant Field Values

KEY_ACTIONSET

public static final java.lang.String KEY_ACTIONSET

See Also:

Constant Field Values

KEY_VERBOSE

public static final java.lang.String KEY_VERBOSE

See Also:

Constant Field Values

Constructor Detail

HelpOptions

public HelpOptions()

HelpOptions

public HelpOptions(CASActionOptions options)

Method Detail

getServerDefaultValue

public java.lang.Object getServerDefaultValue(java.lang.String key)

Description copied from class: CASActionOptions

Gets the server default value, if known.

Overrides:

getServerDefaultValue in class CASActionOptions

Parameters:

key - The parameter key

Returns:

THe default value, or null if not known

getAction

public java.lang.String getAction()

setAction

public HelpOptions setAction(java.lang.String value)

Sets the value of parameter 'action': specifies the name of the action for which you want help. The name can be in the form 'actionSetName.actionName' or just 'actionName.

Parameters:

value - The value

Returns:

The options object

getActionSet

public java.lang.String getActionSet()

setActionSet

public HelpOptions setActionSet(java.lang.String value)

Sets the value of parameter 'actionSet': specifies the name of the action set for which you want help. This parameter is ignored if the action parameter is specified.

Parameters:

value - The value

Returns:

The options object

getVerbose

public java.lang.Boolean getVerbose()

setVerbose

public HelpOptions setVerbose(java.lang.Boolean value)

Sets the value of parameter 'verbose': when set to True, provides more detail for each parameter. The server default is TRUE.

Parameters:

value - The value

Returns:

The options object