CASActionOptions (cas-client 3.2.9 API)

java.lang.Object
- com.sas.cas.CASActionOptions

All Implemented Interfaces:

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

Direct Known Subclasses:

CASGeneratedActionOptions
```
public class CASActionOptions
extends java.lang.Object
implements java.io.Serializable, KeyedMap<java.lang.String,java.lang.Object>
```
Options for invoking a CAS action.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CASActionOptions.EnumValue`
`static class`	`CASActionOptions.FORMAT` Defines the various formats for the toString method.

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 int`	`FLAGS_EXPAND_ARRAYS` Causes CASTable array columns to be expanded.
`static int`	`FLAGS_IGNORE_DISPOSITION_ERROR` A disposition error causes an exception to be thrown.
`static int`	`FLAGS_RETURN_RESULTS_ON_EXCEPTION` Causes results to be queued and set on the CASException if an error returned by the action.
`static int`	`FLAGS_SKIP_ACTION_EVENTS` Causes any action events for this action to be skipped
`static int`	`FLAGS_SKIP_RESULTS` Causes CASClient to skip the materialization of results.
`static java.lang.String`	`HIDDEN_PASSWORD`
`static java.lang.String`	`JSON_NULL`
`static java.lang.String`	`LUA_NIL`
`static int`	`PARAMETER_FLAG_ISPASSWORD`
`static int`	`PARAMETER_FLAG_ISPATH`
`static int`	`PARAMETER_FLAG_ISTABLENAME`
`static int`	`PARAMETER_FLAG_ISVAR`
`static int`	`PARAMETER_FLAG_REQUIRED`
`static java.lang.String`	`PYTHON_NULL`
`static java.lang.String`	`SERIALIZED_PREFIX`

Constructor Summary

Constructors
Constructor and Description
`CASActionOptions()`
`CASActionOptions(CASActionOptions options)`
`CASActionOptions(CASClientInterface client)`
`CASActionOptions(java.lang.String actionSetName, java.lang.String actionName)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addActionFlags(int flags)`
`void`	`addParameterFlag(java.lang.String key, int flag)` Adds a flag to the given parameter key.
`protected static void`	`appendValue(CASActionOptions.FORMAT format, java.lang.StringBuffer sb, com.sas.cas.proto.CASClientProto.Value value)`
`protected void`	`checkForPasswords(java.util.Map<java.lang.String,java.lang.Object> p)`
`void`	`clear()`
`boolean`	`containsKey(java.lang.Object key)`
`boolean`	`containsValue(java.lang.Object value)`
`protected void`	`convertToEnumArray(java.lang.String[] a, java.lang.Object values)`
`void`	`copy(CASActionOptions options)` Copies the event listeners and handlers from the given options.
`static CASActionOptions`	`deserialize(java.lang.String code)` Attempts to deserialize the given code.
`java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.Object>>`	`entrySet()`
`boolean`	`equals(java.lang.Object o)`
`protected static java.lang.Class<?>`	`findOptionsClass(CASActionOptions options)`
`protected static java.lang.reflect.Method`	`findSetter(java.lang.Class<?> cls, java.lang.String key)`
`java.lang.Object`	`get(java.lang.Object key)`
`int`	`getActionFlags()`
`java.lang.String`	`getActionName()`
`CASActionResponseEventListener`	`getActionResponseEventListener()`
`CASActionResultEventListener`	`getActionResultEventListener()`
`java.lang.String`	`getActionSetName()`
`CASClientInterface`	`getCASClient()` Gets the client interface used to invoke this action.
`protected static java.lang.String`	`getClassName(java.lang.Class<?> cls)`
`CASDebugOptions`	`getDebugOptions()`
`CASDispositionEventListener`	`getDispositionEventListener()`
`java.lang.String`	`getFullyQualifiedActionName()` Returns the fully qualified action name, such as "builtins.reflect".
`CASLogEventListener`	`getLogEventListener()`
`java.lang.String`	`getLogMessage()`
`java.io.OutputStream`	`getMessageOutputStream()`
`CASMessageTagHandler`	`getMessageTagHandler(int tag)` Gets a registered message tag handler for the given tag.
`java.lang.Object`	`getParameter(java.lang.String key)` Get the parameter value for the given key.
`java.lang.Boolean`	`getParameterAsBoolean(java.lang.String key)` Gets the parameter value for the given key as a Boolean.
`byte[]`	`getParameterAsByteArray(java.lang.String key)`
`java.lang.Double`	`getParameterAsDouble(java.lang.String key)` Gets the parameter value for the given key as a Double.
`java.lang.Double[]`	`getParameterAsDoubleArray(java.lang.String key)` Gets the parameter value for the given key as a Double array.
`java.lang.Integer`	`getParameterAsInteger(java.lang.String key)` Gets the parameter value for the given key as an Integer.
`java.lang.Integer[]`	`getParameterAsIntegerArray(java.lang.String key)` Gets the parameter value for the given key as an Integer array.
`java.lang.Long`	`getParameterAsLong(java.lang.String key)` Gets the parameter value for the given key as a Long.
`java.lang.Long[]`	`getParameterAsLongArray(java.lang.String key)` Gets the parameter value for the given key as a Long array.
`java.lang.String`	`getParameterAsString(java.lang.String key)` Gets the parameter value for the given key as a String.
`java.lang.String[]`	`getParameterAsStringArray(java.lang.String key)` Gets the parameter value for the given key as a String array.
`java.lang.Integer`	`getParameterFlags(java.lang.String key)` Returns the parameter flags for the given key.
`static java.lang.Object`	`getParameterIgnoreCase(java.util.Map<java.lang.String,java.lang.Object> map, java.lang.String key)` Gets the parameter value for the given key.
`java.lang.Object`	`getParameterIgnoreCase(java.lang.String key)` Gets the parameter value for the given key.
`java.util.Iterator<java.lang.String>`	`getParameterKeys()` Returns all of the parameter keys.
`CASPerformanceEventListener`	`getPerformanceEventListener()`
`java.lang.String`	`getPropertyKey()` Gets the key value for this set of properties.
`java.lang.Object`	`getServerDefaultValue(java.lang.String key)` Gets the server default value, if known.
`java.lang.String`	`getSessionID()`
`java.lang.Object`	`getUserProperty(java.lang.String key)` Returns the user property associated with the given key.
`java.util.Iterator<java.lang.String>`	`getUserPropertyKeys()` Returns an iterator of user property keys.
`int`	`hashCode()`
`CASActionResults<CASValue>`	`invoke()` Invokes the CAS action represented by this options object.
`boolean`	`isEmpty()`
`boolean`	`isFlagSet(int flag)`
`protected static boolean`	`isMap(java.lang.Class<?> cls)`
`protected boolean`	`isParameterFlagSet(java.lang.String key, int flag)`
`boolean`	`isPassword(java.lang.String key)` Returns true if the given parameter represents a password.
`boolean`	`isPath(java.lang.String key)` Returns true if the given parameter represents a file path.
`boolean`	`isRequired(java.lang.String key)` Returns true if the given parameter is required.
`boolean`	`isTable(java.lang.String key)` Returns true if the given parameter represents a table.
`boolean`	`isVariable(java.lang.String key)` Returns true if the given parameter represents a variable or a variable list.
`java.util.Set<java.lang.String>`	`keySet()`
`java.lang.Object`	`put(java.lang.String key, java.lang.Object value)`
`void`	`putAll(java.util.Map<? extends java.lang.String,? extends java.lang.Object> m)`
`void`	`putAllDeep(java.util.Map<? extends java.lang.String,? extends java.lang.Object> m)` Performs a deep copy.
`protected void`	`putDeep(java.util.Map<java.lang.String,java.lang.Object> target, java.util.Map<? extends java.lang.String,? extends java.lang.Object> m)`
`protected void`	`putDeep(java.util.Map<java.lang.String,java.lang.Object> target, java.lang.String key, java.lang.Object value)`
`protected java.lang.String`	`quoteIfNotNull(java.lang.String s)`
`java.lang.Object`	`remove(java.lang.Object key)`
`java.lang.Object`	`removeParameter(java.lang.String key)` Removes an action parameter.
`static boolean`	`set(com.sas.cas.proto.CASClientProto.Value.Builder valueBuilder, java.lang.String key, java.lang.Object value)` Sets the appropriate type data on the given ValueBuilder.
`CASActionOptions`	`setActionFlags(int flags)` Sets any flags on the options.
`CASActionOptions`	`setActionName(java.lang.String actionName)` Sets the action name.
`CASActionOptions`	`setActionResponseEventListener(CASActionResponseEventListener responseEventListener)` Sets the response event listener for this action request.
`CASActionOptions`	`setActionResultEventListener(CASActionResultEventListener resultEventListener)` Sets the result event listener for this action request.
`CASActionOptions`	`setActionSetName(java.lang.String actionSetName)` Sets the action set name.
`CASActionOptions`	`setCASClient(CASClientInterface client)`
`CASActionOptions`	`setDebugOptions(CASDebugOptions debugOptions)` Sets debug options for the given action.
`CASActionOptions`	`setDispositionEventListener(CASDispositionEventListener dispositionEventListener)` Sets the disposition event listener for this action request.
`CASActionOptions`	`setFullyQualifiedActionName(java.lang.String name)` Sets the fully qualified action name, such as "builtins_reflect" or "builtins.reflect".
`CASActionOptions`	`setLogEventListener(CASLogEventListener logEventListener)` Sets the log event listener for this action request.
`CASActionOptions`	`setLogMessage(java.lang.String logMessage)` Sets a message which will be added to the log of the first response.
`CASActionOptions`	`setMessageOutputStream(java.io.OutputStream messageOutputStream)` Sets an output stream that will receive each response message from the action.
`CASActionOptions`	`setMessageTagHandler(int tag, CASMessageTagHandler handler)` Sets a message tag handler for the given tag.
`CASActionOptions`	`setParameter(java.lang.String key, java.lang.Object value)` Sets an action parameter.
`CASActionOptions`	`setPerformanceEventListener(CASPerformanceEventListener performanceEventListener)` Sets the performance event listener for this action request.
`void`	`setPropertyKey(java.lang.String key)` Sets the key value for this set of properties.
`CASActionOptions`	`setSessionID(java.lang.String sessionID)` Sets the session ID for this action.
`CASActionOptions`	`setUserProperty(java.lang.String key, java.lang.Object value)` Sets a user property.
`int`	`size()`
`java.lang.String`	`toCASLString()` Returns the representation of this action object in CASL format.
`java.lang.String`	`toLuaString()` Returns the representation of this action object in lua format.
`static java.lang.String`	`toLuaString(com.sas.cas.proto.CASClientProto.Request request)` Returns the representation of the given request in lua format.
`CASActionOptions`	`toOptionsWithGeneratedClasses()` This method makes an attempt to convert any maps of key/value pairs into their corresponding generated classes.
`protected java.lang.String`	`toSerialized(CASActionOptions options)` Serializes the given options to a string representation.
`java.lang.String`	`toString()`
`java.lang.String`	`toString(CASActionOptions.FORMAT format)` Returns the representation of this action object in the given format.
`static java.lang.String`	`toString(com.sas.cas.proto.CASClientProto.Request request)` Returns the representation of the given request in string format.
`protected static java.lang.String`	`upcaseFirstChar(java.lang.String s)`
`java.util.Collection<java.lang.Object>`	`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
  - FLAGS_SKIP_RESULTS
```
public static final int FLAGS_SKIP_RESULTS
```
    Causes CASClient to skip the materialization of results.
    
    See Also:
    
    Constant Field Values
  - FLAGS_EXPAND_ARRAYS
```
public static final int FLAGS_EXPAND_ARRAYS
```
    Causes CASTable array columns to be expanded.
    
    See Also:
    
    Constant Field Values
  - FLAGS_SKIP_ACTION_EVENTS
```
public static final int FLAGS_SKIP_ACTION_EVENTS
```
    Causes any action events for this action to be skipped
    
    See Also:
    
    Constant Field Values
  - FLAGS_RETURN_RESULTS_ON_EXCEPTION
```
public static final int FLAGS_RETURN_RESULTS_ON_EXCEPTION
```
    Causes results to be queued and set on the CASException if an error returned by the action.
    
    See Also:
    
    Constant Field Values
  - FLAGS_IGNORE_DISPOSITION_ERROR
```
public static final int FLAGS_IGNORE_DISPOSITION_ERROR
```
    A disposition error causes an exception to be thrown. Setting this flag will ignore errors.
    
    See Also:
    
    Constant Field Values
  - LUA_NIL
```
public static final java.lang.String LUA_NIL
```
    See Also:
    
    Constant Field Values
  - JSON_NULL
```
public static final java.lang.String JSON_NULL
```
    See Also:
    
    Constant Field Values
  - PYTHON_NULL
```
public static final java.lang.String PYTHON_NULL
```
    See Also:
    
    Constant Field Values
  - HIDDEN_PASSWORD
```
public static final java.lang.String HIDDEN_PASSWORD
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_PREFIX
```
public static final java.lang.String SERIALIZED_PREFIX
```
    See Also:
    
    Constant Field Values
  - PARAMETER_FLAG_REQUIRED
```
public static final int PARAMETER_FLAG_REQUIRED
```
    See Also:
    
    Constant Field Values
  - PARAMETER_FLAG_ISTABLENAME
```
public static final int PARAMETER_FLAG_ISTABLENAME
```
    See Also:
    
    Constant Field Values
  - PARAMETER_FLAG_ISPATH
```
public static final int PARAMETER_FLAG_ISPATH
```
    See Also:
    
    Constant Field Values
  - PARAMETER_FLAG_ISVAR
```
public static final int PARAMETER_FLAG_ISVAR
```
    See Also:
    
    Constant Field Values
  - PARAMETER_FLAG_ISPASSWORD
```
public static final int PARAMETER_FLAG_ISPASSWORD
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - CASActionOptions
```
public CASActionOptions()
```
  - CASActionOptions
```
public CASActionOptions(CASClientInterface client)
```
  - CASActionOptions
```
public CASActionOptions(java.lang.String actionSetName,
                        java.lang.String actionName)
```
  - CASActionOptions
```
public CASActionOptions(CASActionOptions options)
```
- Method Detail
  - copy
```
public void copy(CASActionOptions options)
```
    Copies the event listeners and handlers from the given options.
    
    Parameters:
    
    options - The options to copy from
  - getActionSetName
```
public java.lang.String getActionSetName()
```
  - setActionSetName
```
public CASActionOptions setActionSetName(java.lang.String actionSetName)
```
    Sets the action set name.
    
    Parameters:
    
    actionSetName - The action set name
  - getActionName
```
public java.lang.String getActionName()
```
  - setActionName
```
public CASActionOptions setActionName(java.lang.String actionName)
```
    Sets the action name.
    
    Parameters:
    
    actionName - The action name
  - getSessionID
```
public java.lang.String getSessionID()
```
  - setSessionID
```
public CASActionOptions setSessionID(java.lang.String sessionID)
```
    Sets the session ID for this action.
    
    Parameters:
    
    sessionID - The session ID
  - getCASClient
```
public CASClientInterface getCASClient()
```
    Gets the client interface used to invoke this action.
    
    Returns:
    
    The client interface
  - setCASClient
```
public CASActionOptions setCASClient(CASClientInterface client)
```
  - getActionFlags
```
public int getActionFlags()
```
  - setActionFlags
```
public CASActionOptions setActionFlags(int flags)
```
    Sets any flags on the options.
    
    Parameters:
    
    flags - The flags
  - addActionFlags
```
public void addActionFlags(int flags)
```
  - isFlagSet
```
public boolean isFlagSet(int flag)
```
  - addParameterFlag
```
public void addParameterFlag(java.lang.String key,
                             int flag)
```
    Adds a flag to the given parameter key.
    
    Parameters:
    
    key - The key
    
    flag - The parameter flag
  - getParameterFlags
```
public java.lang.Integer getParameterFlags(java.lang.String key)
```
    Returns the parameter flags for the given key.
    
    Parameters:
    
    key - The key
    
    Returns:
    
    The flags, or null for none
  - isParameterFlagSet
```
protected boolean isParameterFlagSet(java.lang.String key,
                                     int flag)
```
  - isRequired
```
public boolean isRequired(java.lang.String key)
```
    Returns true if the given parameter is required.
    
    Parameters:
    
    key - The parameter key
    
    Returns:
    
    true if required
  - isTable
```
public boolean isTable(java.lang.String key)
```
    Returns true if the given parameter represents a table.
    
    Parameters:
    
    key - The parameter key
    
    Returns:
    
    true if a table
  - isPath
```
public boolean isPath(java.lang.String key)
```
    Returns true if the given parameter represents a file path.
    
    Parameters:
    
    key - The parameter key
    
    Returns:
    
    true if a file path
  - isVariable
```
public boolean isVariable(java.lang.String key)
```
    Returns true if the given parameter represents a variable or a variable list.
    
    Parameters:
    
    key - The parameter key
    
    Returns:
    
    true if a variable
  - isPassword
```
public boolean isPassword(java.lang.String key)
```
    Returns true if the given parameter represents a password.
    
    Parameters:
    
    key - The parameter key
    
    Returns:
    
    true if a password
  - getServerDefaultValue
```
public java.lang.Object getServerDefaultValue(java.lang.String key)
```
    Gets the server default value, if known.
    
    Parameters:
    
    key - The parameter key
    
    Returns:
    
    THe default value, or null if not known
  - setParameter
```
public CASActionOptions setParameter(java.lang.String key,
                                     java.lang.Object value)
```
    Sets an action parameter.
    
    Parameters:
    
    key - The key name
    
    value - The value
  - removeParameter
```
public java.lang.Object removeParameter(java.lang.String key)
```
    Removes an action parameter.
    
    Parameters:
    
    key - The key name
    
    Returns:
    
    The value of the removed key, or null if the key did not exist
  - getParameter
```
public java.lang.Object getParameter(java.lang.String key)
```
    Get the parameter value for the given key.
    
    Parameters:
    
    key - The key name
    
    Returns:
    
    The value, or null if not found
  - getParameterIgnoreCase
```
public java.lang.Object getParameterIgnoreCase(java.lang.String key)
```
    Gets the parameter value for the given key. The key is case-insensitive.
    
    Parameters:
    
    key - The key name
    
    Returns:
    
    The value, or null if not found
  - getParameterIgnoreCase
```
public static java.lang.Object getParameterIgnoreCase(java.util.Map<java.lang.String,java.lang.Object> map,
                                                      java.lang.String key)
```
    Gets the parameter value for the given key. The key is case-insensitive.
    
    Parameters:
    
    map - The map of keys/values
    
    key - The key name
    
    Returns:
    
    The value, or null if not found
  - getParameterAsString
```
public java.lang.String getParameterAsString(java.lang.String key)
```
    Gets the parameter value for the given key as a String.
    
    Parameters:
    
    key - The key name
    
    Returns:
    
    The value as a String, or null if not found
  - getParameterAsDouble
```
public java.lang.Double getParameterAsDouble(java.lang.String key)
```
    Gets the parameter value for the given key as a Double.
    
    Parameters:
    
    key - The key name
    
    Returns:
    
    The value as a Double, or null if not found
  - getParameterAsBoolean
```
public java.lang.Boolean getParameterAsBoolean(java.lang.String key)
```
    Gets the parameter value for the given key as a Boolean.
    
    Parameters:
    
    key - The key name
    
    Returns:
    
    The value as a Boolean, or null if not found
  - getParameterAsInteger
```
public java.lang.Integer getParameterAsInteger(java.lang.String key)
```
    Gets the parameter value for the given key as an Integer.
    
    Parameters:
    
    key - The key name
    
    Returns:
    
    The value as an Integer, or null if not found
  - getParameterAsLong
```
public java.lang.Long getParameterAsLong(java.lang.String key)
```
    Gets the parameter value for the given key as a Long.
    
    Parameters:
    
    key - The key name
    
    Returns:
    
    The value as a Long, or null if not found
  - getParameterAsStringArray
```
public java.lang.String[] getParameterAsStringArray(java.lang.String key)
```
    Gets the parameter value for the given key as a String array.
    
    Parameters:
    
    key - The key name
    
    Returns:
    
    The value as a String array, or null if not found
  - getParameterAsDoubleArray
```
public java.lang.Double[] getParameterAsDoubleArray(java.lang.String key)
```
    Gets the parameter value for the given key as a Double array.
    
    Parameters:
    
    key - The key name
    
    Returns:
    
    The value as a Double array, or null if not found
  - getParameterAsIntegerArray
```
public java.lang.Integer[] getParameterAsIntegerArray(java.lang.String key)
```
    Gets the parameter value for the given key as an Integer array.
    
    Parameters:
    
    key - The key name
    
    Returns:
    
    The value as an Integer array, or null if not found
  - getParameterAsLongArray
```
public java.lang.Long[] getParameterAsLongArray(java.lang.String key)
```
    Gets the parameter value for the given key as a Long array.
    
    Parameters:
    
    key - The key name
    
    Returns:
    
    The value as a Long array, or null if not found
  - getParameterAsByteArray
```
public byte[] getParameterAsByteArray(java.lang.String key)
```
  - convertToEnumArray
```
protected void convertToEnumArray(java.lang.String[] a,
                                  java.lang.Object values)
```
  - getParameterKeys
```
public java.util.Iterator<java.lang.String> getParameterKeys()
```
    Returns all of the parameter keys.
    
    Returns:
    
    The parameter key iterator
  - setUserProperty
```
public CASActionOptions setUserProperty(java.lang.String key,
                                        java.lang.Object value)
```
    Sets a user property.
    
    Parameters:
    
    key - The property key
    
    value - The property value, or null to remove the key
  - getUserProperty
```
public java.lang.Object getUserProperty(java.lang.String key)
```
    Returns the user property associated with the given key.
    
    Parameters:
    
    key - The property key
    
    Returns:
    
    The value bound to the key, or null if not found
  - getUserPropertyKeys
```
public java.util.Iterator<java.lang.String> getUserPropertyKeys()
```
    Returns an iterator of user property keys.
    
    Returns:
    
    The user property keys
  - getFullyQualifiedActionName
```
public java.lang.String getFullyQualifiedActionName()
```
    Returns the fully qualified action name, such as "builtins.reflect".
    
    Returns:
    
    The fully qualified name
  - setFullyQualifiedActionName
```
public CASActionOptions setFullyQualifiedActionName(java.lang.String name)
```
    Sets the fully qualified action name, such as "builtins_reflect" or "builtins.reflect".
    
    Parameters:
    
    name - The action name
  - getDebugOptions
```
public CASDebugOptions getDebugOptions()
```
  - setDebugOptions
```
public CASActionOptions setDebugOptions(CASDebugOptions debugOptions)
```
    Sets debug options for the given action.
    
    Parameters:
    
    debugOptions - The debug options
  - getLogEventListener
```
public CASLogEventListener getLogEventListener()
```
  - setLogEventListener
```
public CASActionOptions setLogEventListener(CASLogEventListener logEventListener)
```
    Sets the log event listener for this action request.
    
    Parameters:
    
    logEventListener - The log event listener.
  - getDispositionEventListener
```
public CASDispositionEventListener getDispositionEventListener()
```
  - setDispositionEventListener
```
public CASActionOptions setDispositionEventListener(CASDispositionEventListener dispositionEventListener)
```
    Sets the disposition event listener for this action request.
    
    Parameters:
    
    dispositionEventListener - The disposition event listener
  - getPerformanceEventListener
```
public CASPerformanceEventListener getPerformanceEventListener()
```
  - setPerformanceEventListener
```
public CASActionOptions setPerformanceEventListener(CASPerformanceEventListener performanceEventListener)
```
    Sets the performance event listener for this action request.
    
    Parameters:
    
    performanceEventListener - The performance event listener
  - getActionResultEventListener
```
public CASActionResultEventListener getActionResultEventListener()
```
  - setActionResultEventListener
```
public CASActionOptions setActionResultEventListener(CASActionResultEventListener resultEventListener)
```
    Sets the result event listener for this action request.
    
    Parameters:
    
    resultEventListener - The result event listener
  - getActionResponseEventListener
```
public CASActionResponseEventListener getActionResponseEventListener()
```
  - setActionResponseEventListener
```
public CASActionOptions setActionResponseEventListener(CASActionResponseEventListener responseEventListener)
```
    Sets the response event listener for this action request. Multiple responses may occur within the same action invocation.
    
    Parameters:
    
    responseEventListener - The response event listener
  - setMessageTagHandler
```
public CASActionOptions setMessageTagHandler(int tag,
                                             CASMessageTagHandler handler)
```
    Sets a message tag handler for the given tag.
    
    Parameters:
    
    tag - The tag
    
    handler - The handler, or null to remove
  - getMessageTagHandler
```
public CASMessageTagHandler getMessageTagHandler(int tag)
```
    Gets a registered message tag handler for the given tag. If a handler is not found for the given tag, the tag ANY is used if registered.
    
    Parameters:
    
    tag - The tag
    
    Returns:
    
    The handler, or null if none.
  - getMessageOutputStream
```
public java.io.OutputStream getMessageOutputStream()
```
  - setMessageOutputStream
```
public CASActionOptions setMessageOutputStream(java.io.OutputStream messageOutputStream)
```
    Sets an output stream that will receive each response message from the action.
    
    Parameters:
    
    messageOutputStream - The output stream
  - getLogMessage
```
public java.lang.String getLogMessage()
```
  - setLogMessage
```
public CASActionOptions setLogMessage(java.lang.String logMessage)
```
    Sets a message which will be added to the log of the first response.
    
    Parameters:
    
    logMessage - The message, or null for none
  - invoke
```
public CASActionResults<CASValue> invoke()
                                  throws CASException,
                                         java.io.IOException
```
    Invokes the CAS action represented by this options object. The currently active client context will be used to invoke the action. If no context is active, an exception will be thrown.
    The currently active client is either the last client instantiated, the last client to have invoked an action, or the last client to be set as the active client context (setAsActiveClientContext)
    
    Returns:
    
    The results
    
    Throws:
    
    CASException
    
    java.io.IOException
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - setPropertyKey
```
public void setPropertyKey(java.lang.String key)
```
    Description copied from interface: KeyedMap
    
    Sets the key value for this set of properties.
    
    Specified by:
    
    setPropertyKey in interface KeyedMap<java.lang.String,java.lang.Object>
    
    Parameters:
    
    key - The key
  - getPropertyKey
```
public java.lang.String getPropertyKey()
```
    Description copied from interface: KeyedMap
    
    Gets the key value for this set of properties.
    
    Specified by:
    
    getPropertyKey in interface KeyedMap<java.lang.String,java.lang.Object>
    
    Returns:
    
    The key, or null for none
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface java.util.Map<java.lang.String,java.lang.Object>
  - containsKey
```
public boolean containsKey(java.lang.Object key)
```
    Specified by:
    
    containsKey in interface java.util.Map<java.lang.String,java.lang.Object>
  - containsValue
```
public boolean containsValue(java.lang.Object value)
```
    Specified by:
    
    containsValue in interface java.util.Map<java.lang.String,java.lang.Object>
  - entrySet
```
public java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.Object>> entrySet()
```
    Specified by:
    
    entrySet in interface java.util.Map<java.lang.String,java.lang.Object>
  - equals
```
public boolean equals(java.lang.Object o)
```
    Specified by:
    
    equals in interface java.util.Map<java.lang.String,java.lang.Object>
    
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in interface java.util.Map<java.lang.String,java.lang.Object>
    
    Overrides:
    
    hashCode in class java.lang.Object
  - get
```
public java.lang.Object get(java.lang.Object key)
```
    Specified by:
    
    get in interface java.util.Map<java.lang.String,java.lang.Object>
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface java.util.Map<java.lang.String,java.lang.Object>
  - keySet
```
public java.util.Set<java.lang.String> keySet()
```
    Specified by:
    
    keySet in interface java.util.Map<java.lang.String,java.lang.Object>
  - put
```
public java.lang.Object put(java.lang.String key,
                            java.lang.Object value)
```
    Specified by:
    
    put in interface java.util.Map<java.lang.String,java.lang.Object>
  - putAll
```
public void putAll(java.util.Map<? extends java.lang.String,? extends java.lang.Object> m)
```
    Specified by:
    
    putAll in interface java.util.Map<java.lang.String,java.lang.Object>
  - putAllDeep
```
public void putAllDeep(java.util.Map<? extends java.lang.String,? extends java.lang.Object> m)
```
    Performs a deep copy. Checks for nested Maps.
    
    Parameters:
    
    m - Mappings to be stored in this map
  - putDeep
```
protected void putDeep(java.util.Map<java.lang.String,java.lang.Object> target,
                       java.util.Map<? extends java.lang.String,? extends java.lang.Object> m)
```
  - putDeep
```
protected void putDeep(java.util.Map<java.lang.String,java.lang.Object> target,
                       java.lang.String key,
                       java.lang.Object value)
```
  - remove
```
public java.lang.Object remove(java.lang.Object key)
```
    Specified by:
    
    remove in interface java.util.Map<java.lang.String,java.lang.Object>
  - size
```
public int size()
```
    Specified by:
    
    size in interface java.util.Map<java.lang.String,java.lang.Object>
  - values
```
public java.util.Collection<java.lang.Object> values()
```
    Specified by:
    
    values in interface java.util.Map<java.lang.String,java.lang.Object>
  - toLuaString
```
public java.lang.String toLuaString()
```
    Returns the representation of this action object in lua format.
    
    Returns:
    
    The lua representation
  - toCASLString
```
public java.lang.String toCASLString()
```
    Returns the representation of this action object in CASL format.
    
    Returns:
    
    The CASL representation
  - toLuaString
```
public static java.lang.String toLuaString(com.sas.cas.proto.CASClientProto.Request request)
```
    Returns the representation of the given request in lua format.
    
    Parameters:
    
    request - The request
    
    Returns:
    
    The lua representation
  - toString
```
public static java.lang.String toString(com.sas.cas.proto.CASClientProto.Request request)
```
    Returns the representation of the given request in string format.
    
    Parameters:
    
    request - The request
    
    Returns:
    
    The string representation
  - appendValue
```
protected static void appendValue(CASActionOptions.FORMAT format,
                                  java.lang.StringBuffer sb,
                                  com.sas.cas.proto.CASClientProto.Value value)
```
  - toString
```
public java.lang.String toString(CASActionOptions.FORMAT format)
```
    Returns the representation of this action object in the given format.
    
    Parameters:
    
    format - The format
    
    Returns:
    
    The string representation
  - toSerialized
```
protected java.lang.String toSerialized(CASActionOptions options)
```
    Serializes the given options to a string representation.
    
    Parameters:
    
    options - The options
    
    Returns:
    
    The serialized representation
  - deserialize
```
public static CASActionOptions deserialize(java.lang.String code)
```
    Attempts to deserialize the given code.
    
    Parameters:
    
    code - The code
    
    Returns:
    
    The options, or null if not valid code
  - checkForPasswords
```
protected void checkForPasswords(java.util.Map<java.lang.String,java.lang.Object> p)
```
  - quoteIfNotNull
```
protected java.lang.String quoteIfNotNull(java.lang.String s)
```
  - findOptionsClass
```
protected static java.lang.Class<?> findOptionsClass(CASActionOptions options)
```
  - upcaseFirstChar
```
protected static java.lang.String upcaseFirstChar(java.lang.String s)
```
  - getClassName
```
protected static java.lang.String getClassName(java.lang.Class<?> cls)
```
  - findSetter
```
protected static java.lang.reflect.Method findSetter(java.lang.Class<?> cls,
                                                     java.lang.String key)
```
  - isMap
```
protected static boolean isMap(java.lang.Class<?> cls)
```
  - set
```
public static boolean set(com.sas.cas.proto.CASClientProto.Value.Builder valueBuilder,
                          java.lang.String key,
                          java.lang.Object value)
```
    Sets the appropriate type data on the given ValueBuilder.
    
    Parameters:
    
    valueBuilder - The value builder
    
    key - The value key
    
    value - The raw value
    
    Returns:
    
    true if the value should be used
  - toOptionsWithGeneratedClasses
```
public CASActionOptions toOptionsWithGeneratedClasses()
```
    This method makes an attempt to convert any maps of key/value pairs into their corresponding generated classes. This may be necessary if the parameter flags on the generated classes should be preserved (for example, isPassword).

Class CASActionOptions

Nested Class Summary

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

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Field Detail

FLAGS_SKIP_RESULTS

FLAGS_EXPAND_ARRAYS

FLAGS_SKIP_ACTION_EVENTS

FLAGS_RETURN_RESULTS_ON_EXCEPTION

FLAGS_IGNORE_DISPOSITION_ERROR

LUA_NIL

JSON_NULL

PYTHON_NULL

HIDDEN_PASSWORD

SERIALIZED_PREFIX

PARAMETER_FLAG_REQUIRED

PARAMETER_FLAG_ISTABLENAME

PARAMETER_FLAG_ISPATH

PARAMETER_FLAG_ISVAR

PARAMETER_FLAG_ISPASSWORD

Constructor Detail

CASActionOptions

CASActionOptions

CASActionOptions

CASActionOptions

Method Detail

copy

getActionSetName

setActionSetName

getActionName

setActionName

getSessionID

setSessionID

getCASClient

setCASClient

getActionFlags

setActionFlags

addActionFlags

isFlagSet

addParameterFlag

getParameterFlags

isParameterFlagSet

isRequired

isTable

isPath

isVariable

isPassword

getServerDefaultValue

setParameter

removeParameter

getParameter

getParameterIgnoreCase

getParameterIgnoreCase

getParameterAsString

getParameterAsDouble

getParameterAsBoolean

getParameterAsInteger

getParameterAsLong

getParameterAsStringArray

getParameterAsDoubleArray

getParameterAsIntegerArray

getParameterAsLongArray

getParameterAsByteArray

convertToEnumArray

getParameterKeys

setUserProperty

getUserProperty

getUserPropertyKeys

getFullyQualifiedActionName

setFullyQualifiedActionName

getDebugOptions

setDebugOptions

getLogEventListener

setLogEventListener

getDispositionEventListener

setDispositionEventListener