com.sas.cas.actions.planning

Class CpsQueryTaskOptions

java.lang.Object

com.sas.cas.CASActionOptions

com.sas.cas.CASGeneratedActionOptions

com.sas.cas.actions.planning.CpsQueryTaskOptions

All Implemented Interfaces:

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

public class CpsQueryTaskOptions
extends CASGeneratedActionOptions

Options for cpsQueryTask: Query the cube for leafs and/or rollups.

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_ADDITIONALFACTS
static java.lang.String	KEY_COMPRESSIONS
static java.lang.String	KEY_CPUIDX
static java.lang.String	KEY_DATA
static java.lang.String	KEY_DATAMAPREFRESH
static java.lang.String	KEY_FACTSETS
static java.lang.String	KEY_FORMULAS
static java.lang.String	KEY_GUID
static java.lang.String	KEY_HINTS
static java.lang.String	KEY_INCLUDEIDS
static java.lang.String	KEY_MAP
static java.lang.String	KEY_MAXFACTS
static java.lang.String	KEY_PARTITIONORDINAL
static java.lang.String	KEY_PARTITIONTABLE
static java.lang.String	KEY_QUERYCUBEID
static java.lang.String	KEY_REQUEST
static java.lang.String	KEY_VCUBEID
static java.lang.String	KEY_WHERECLAUSE

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

Method Summary

Modifier and Type	Method and Description
CpsFact[]	getAdditionalFacts()
CpsDimTypeCompressions[]	getCompressions()
java.lang.Integer	getCpuIdx()
byte[]	getData()
java.lang.Boolean	getDataMapRefresh()
CpsExecuteFactSets[]	getFactsets()
CpsFormula[]	getFormulas()
java.lang.Integer	getGuid()
byte[]	getHints()
java.lang.Boolean	getIncludeIds()
byte[]	getMap()
java.lang.Integer	getMaxFacts()
java.lang.Integer	getPartitionOrdinal()
Castable	getPartitionTable()
java.lang.Integer	getQueryCubeId()
byte[]	getRequest()
java.lang.Object	getServerDefaultValue(java.lang.String key) Gets the server default value, if known.
java.lang.Integer	getVcubeId()
java.lang.String	getWhereClause()
CpsQueryTaskOptions	setAdditionalFacts(CpsFact[] value) Sets the value of parameter 'additionalFacts'.
CpsQueryTaskOptions	setCompressions(CpsDimTypeCompressions[] value) Sets the value of parameter 'compressions'.
CpsQueryTaskOptions	setCpuIdx(java.lang.Integer value) Sets the value of parameter 'cpuIdx'.
CpsQueryTaskOptions	setData(byte[] value) Sets the value of parameter 'data'.
CpsQueryTaskOptions	setDataMapRefresh(java.lang.Boolean value) Sets the value of parameter 'dataMapRefresh'.
CpsQueryTaskOptions	setFactsets(CpsExecuteFactSets[] value) Sets the value of parameter 'factsets'.
CpsQueryTaskOptions	setFormulas(CpsFormula[] value) Sets the value of parameter 'formulas'.
CpsQueryTaskOptions	setGuid(java.lang.Integer value) Sets the value of parameter 'guid'.
CpsQueryTaskOptions	setHints(byte[] value) Sets the value of parameter 'hints'.
CpsQueryTaskOptions	setIncludeIds(java.lang.Boolean value) Sets the value of parameter 'includeIds'.
CpsQueryTaskOptions	setMap(byte[] value) Sets the value of parameter 'map'.
CpsQueryTaskOptions	setMaxFacts(java.lang.Integer value) Sets the value of parameter 'maxFacts'.
CpsQueryTaskOptions	setPartitionOrdinal(java.lang.Integer value) Sets the value of parameter 'partitionOrdinal'.
CpsQueryTaskOptions	setPartitionTable(Castable value) Sets the value of parameter 'partitionTable': specifies the settings for an input table.
CpsQueryTaskOptions	setQueryCubeId(java.lang.Integer value) Sets the value of parameter 'queryCubeId'.
CpsQueryTaskOptions	setRequest(byte[] value) Sets the value of parameter 'request'.
CpsQueryTaskOptions	setVcubeId(java.lang.Integer value) Sets the value of parameter 'vcubeId'.
CpsQueryTaskOptions	setWhereClause(java.lang.String value) Sets the value of parameter 'whereClause'.

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_FORMULAS

public static final java.lang.String KEY_FORMULAS

See Also:

Constant Field Values

KEY_MAP

public static final java.lang.String KEY_MAP

See Also:

Constant Field Values

KEY_HINTS

public static final java.lang.String KEY_HINTS

See Also:

Constant Field Values

KEY_VCUBEID

public static final java.lang.String KEY_VCUBEID

See Also:

Constant Field Values

KEY_DATA

public static final java.lang.String KEY_DATA

See Also:

Constant Field Values

KEY_REQUEST

public static final java.lang.String KEY_REQUEST

See Also:

Constant Field Values

KEY_GUID

public static final java.lang.String KEY_GUID

See Also:

Constant Field Values

KEY_CPUIDX

public static final java.lang.String KEY_CPUIDX

See Also:

Constant Field Values

KEY_INCLUDEIDS

public static final java.lang.String KEY_INCLUDEIDS

See Also:

Constant Field Values

KEY_MAXFACTS

public static final java.lang.String KEY_MAXFACTS

See Also:

Constant Field Values

KEY_FACTSETS

public static final java.lang.String KEY_FACTSETS

See Also:

Constant Field Values

KEY_COMPRESSIONS

public static final java.lang.String KEY_COMPRESSIONS

See Also:

Constant Field Values

KEY_QUERYCUBEID

public static final java.lang.String KEY_QUERYCUBEID

See Also:

Constant Field Values

KEY_WHERECLAUSE

public static final java.lang.String KEY_WHERECLAUSE

See Also:

Constant Field Values

KEY_ADDITIONALFACTS

public static final java.lang.String KEY_ADDITIONALFACTS

See Also:

Constant Field Values

KEY_PARTITIONORDINAL

public static final java.lang.String KEY_PARTITIONORDINAL

See Also:

Constant Field Values

KEY_DATAMAPREFRESH

public static final java.lang.String KEY_DATAMAPREFRESH

See Also:

Constant Field Values

KEY_PARTITIONTABLE

public static final java.lang.String KEY_PARTITIONTABLE

See Also:

Constant Field Values

Constructor Detail

CpsQueryTaskOptions

public CpsQueryTaskOptions()

CpsQueryTaskOptions

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

getFormulas

public CpsFormula[] getFormulas()

setFormulas

public CpsQueryTaskOptions setFormulas(CpsFormula[] value)

Sets the value of parameter 'formulas'.

Parameters:

value - The value

Returns:

The options object

getMap

public byte[] getMap()

setMap

public CpsQueryTaskOptions setMap(byte[] value)

Sets the value of parameter 'map'.

Parameters:

value - The value

Returns:

The options object

getHints

public byte[] getHints()

setHints

public CpsQueryTaskOptions setHints(byte[] value)

Sets the value of parameter 'hints'.

Parameters:

value - The value

Returns:

The options object

getVcubeId

public java.lang.Integer getVcubeId()

setVcubeId

public CpsQueryTaskOptions setVcubeId(java.lang.Integer value)

Sets the value of parameter 'vcubeId'.

Parameters:

value - The value

Returns:

The options object

getData

public byte[] getData()

setData

public CpsQueryTaskOptions setData(byte[] value)

Sets the value of parameter 'data'.

Parameters:

value - The value

Returns:

The options object

getRequest

public byte[] getRequest()

setRequest

public CpsQueryTaskOptions setRequest(byte[] value)

Sets the value of parameter 'request'.

Parameters:

value - The value

Returns:

The options object

getGuid

public java.lang.Integer getGuid()

setGuid

public CpsQueryTaskOptions setGuid(java.lang.Integer value)

Sets the value of parameter 'guid'.

Parameters:

value - The value

Returns:

The options object

getCpuIdx

public java.lang.Integer getCpuIdx()

setCpuIdx

public CpsQueryTaskOptions setCpuIdx(java.lang.Integer value)

Sets the value of parameter 'cpuIdx'. The server default is 0.

Parameters:

value - The value

Returns:

The options object

getIncludeIds

public java.lang.Boolean getIncludeIds()

setIncludeIds

public CpsQueryTaskOptions setIncludeIds(java.lang.Boolean value)

Sets the value of parameter 'includeIds'. The server default is FALSE.

Parameters:

value - The value

Returns:

The options object

getMaxFacts

public java.lang.Integer getMaxFacts()

setMaxFacts

public CpsQueryTaskOptions setMaxFacts(java.lang.Integer value)

Sets the value of parameter 'maxFacts'. The server default is 0.

Parameters:

value - The value

Returns:

The options object

getFactsets

public CpsExecuteFactSets[] getFactsets()

setFactsets

public CpsQueryTaskOptions setFactsets(CpsExecuteFactSets[] value)

Sets the value of parameter 'factsets'.

Parameters:

value - The value

Returns:

The options object

getCompressions

public CpsDimTypeCompressions[] getCompressions()

setCompressions

public CpsQueryTaskOptions setCompressions(CpsDimTypeCompressions[] value)

Sets the value of parameter 'compressions'.

Parameters:

value - The value

Returns:

The options object

getQueryCubeId

public java.lang.Integer getQueryCubeId()

setQueryCubeId

public CpsQueryTaskOptions setQueryCubeId(java.lang.Integer value)

Sets the value of parameter 'queryCubeId'.

Parameters:

value - The value

Returns:

The options object

getWhereClause

public java.lang.String getWhereClause()

setWhereClause

public CpsQueryTaskOptions setWhereClause(java.lang.String value)

Sets the value of parameter 'whereClause'.

Parameters:

value - The value

Returns:

The options object

getAdditionalFacts

public CpsFact[] getAdditionalFacts()

setAdditionalFacts

public CpsQueryTaskOptions setAdditionalFacts(CpsFact[] value)

Sets the value of parameter 'additionalFacts'.

Parameters:

value - The value

Returns:

The options object

getPartitionOrdinal

public java.lang.Integer getPartitionOrdinal()

setPartitionOrdinal

public CpsQueryTaskOptions setPartitionOrdinal(java.lang.Integer value)

Sets the value of parameter 'partitionOrdinal'.

Parameters:

value - The value

Returns:

The options object

getDataMapRefresh

public java.lang.Boolean getDataMapRefresh()

setDataMapRefresh

public CpsQueryTaskOptions setDataMapRefresh(java.lang.Boolean value)

Sets the value of parameter 'dataMapRefresh'. The server default is FALSE.

Parameters:

value - The value

Returns:

The options object

getPartitionTable

public Castable getPartitionTable()

setPartitionTable

public CpsQueryTaskOptions setPartitionTable(Castable value)

Sets the value of parameter 'partitionTable': specifies the settings for an input table.

Parameters:

value - The value

Returns:

The options object