com.sas.cas.actions.table

Class Fetchorderbyelement

java.lang.Object

com.sas.cas.CASActionOptions

com.sas.cas.CASGeneratedActionOptions

com.sas.cas.actions.table.Fetchorderbyelement

All Implemented Interfaces:

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

public class Fetchorderbyelement
extends CASGeneratedActionOptions

Options for fetch: Fetches rows from a table or view.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Fetchorderbyelement.FORMATTED
static class	Fetchorderbyelement.ORDER

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	KEY_FORMATTED
static java.lang.String	KEY_NAME
static java.lang.String	KEY_ORDER

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
Fetchorderbyelement()
Fetchorderbyelement(CASActionOptions options)

Method Summary

Modifier and Type	Method and Description
Fetchorderbyelement.FORMATTED	getFormatted()
java.lang.String	getName()
Fetchorderbyelement.ORDER	getOrder()
java.lang.Object	getServerDefaultValue(java.lang.String key) Gets the server default value, if known.
Fetchorderbyelement	setFormatted(Fetchorderbyelement.FORMATTED value) Sets the value of parameter 'formatted': specifies whether the formatted or raw value for the variable is used.
Fetchorderbyelement	setName(java.lang.String value) Sets the value of parameter 'name': specifies the variable name to use for sorting.
Fetchorderbyelement	setOrder(Fetchorderbyelement.ORDER value) Sets the value of parameter 'order': specifies whether the ascending or descending value for the variable is used.

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

KEY_NAME

public static final java.lang.String KEY_NAME

See Also:

Constant Field Values

KEY_ORDER

public static final java.lang.String KEY_ORDER

See Also:

Constant Field Values

KEY_FORMATTED

public static final java.lang.String KEY_FORMATTED

See Also:

Constant Field Values

Constructor Detail

Fetchorderbyelement

public Fetchorderbyelement()

Fetchorderbyelement

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

getName

public java.lang.String getName()

setName

public Fetchorderbyelement setName(java.lang.String value)

Sets the value of parameter 'name': specifies the variable name to use for sorting.

Parameters:

value - The value

Returns:

The options object

getOrder

public Fetchorderbyelement.ORDER getOrder()

setOrder

public Fetchorderbyelement setOrder(Fetchorderbyelement.ORDER value)

Sets the value of parameter 'order': specifies whether the ascending or descending value for the variable is used. The server default is ORDER.ASCENDING.

Parameters:

value - The value

Returns:

The options object

getFormatted

public Fetchorderbyelement.FORMATTED getFormatted()

setFormatted

public Fetchorderbyelement setFormatted(Fetchorderbyelement.FORMATTED value)

Sets the value of parameter 'formatted': specifies whether the formatted or raw value for the variable is used. The server default is FORMATTED.RAW.

Parameters:

value - The value

Returns:

The options object