com.sas.cas.actions.builtins

Class HistoryOptions

java.lang.Object

com.sas.cas.CASActionOptions

com.sas.cas.CASGeneratedActionOptions

com.sas.cas.actions.builtins.HistoryOptions

All Implemented Interfaces:

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

public class HistoryOptions
extends CASGeneratedActionOptions

Options for history: Shows the actions that were run in this session.

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_CASOUT
static java.lang.String	KEY_FIRST
static java.lang.String	KEY_LAST
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
HistoryOptions()
HistoryOptions(CASActionOptions options)

Method Summary

Modifier and Type	Method and Description
Casouttable	getCasOut()
java.lang.Integer	getFirst()
java.lang.Integer	getLast()
java.lang.Object	getServerDefaultValue(java.lang.String key) Gets the server default value, if known.
java.lang.Boolean	getVerbose()
HistoryOptions	setCasOut(Casouttable value) Sets the value of parameter 'casOut': specifies the settings for saving the action history to an output table.
HistoryOptions	setFirst(java.lang.Integer value) Sets the value of parameter 'first': specifies the ordinal position for the first action to report on.
HistoryOptions	setLast(java.lang.Integer value) Sets the value of parameter 'last': specifies the ordinal position of the last action to report on.
HistoryOptions	setVerbose(java.lang.Boolean value) Sets the value of parameter 'verbose': prints action information to the client log as well as returns the action information in the results.

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_FIRST

public static final java.lang.String KEY_FIRST

See Also:

Constant Field Values

KEY_LAST

public static final java.lang.String KEY_LAST

See Also:

Constant Field Values

KEY_VERBOSE

public static final java.lang.String KEY_VERBOSE

See Also:

Constant Field Values

KEY_CASOUT

public static final java.lang.String KEY_CASOUT

See Also:

Constant Field Values

Constructor Detail

HistoryOptions

public HistoryOptions()

HistoryOptions

public HistoryOptions(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

getFirst

public java.lang.Integer getFirst()

setFirst

public HistoryOptions setFirst(java.lang.Integer value)

Sets the value of parameter 'first': specifies the ordinal position for the first action to report on. Negative values are subtracted from the current action's ordinal position. The server default is 1.

Parameters:

value - The value

Returns:

The options object

getLast

public java.lang.Integer getLast()

setLast

public HistoryOptions setLast(java.lang.Integer value)

Sets the value of parameter 'last': specifies the ordinal position of the last action to report on. Negative values are subtracted from the current action's ordinal position. The server default is -1.

Parameters:

value - The value

Returns:

The options object

getVerbose

public java.lang.Boolean getVerbose()

setVerbose

public HistoryOptions setVerbose(java.lang.Boolean value)

Sets the value of parameter 'verbose': prints action information to the client log as well as returns the action information in the results. The server default is TRUE.

Parameters:

value - The value

Returns:

The options object

getCasOut

public Casouttable getCasOut()

setCasOut

public HistoryOptions setCasOut(Casouttable value)

Sets the value of parameter 'casOut': specifies the settings for saving the action history to an output table.

Parameters:

value - The value

Returns:

The options object