public class FetchOptions extends CASGeneratedActionOptions
CASActionOptions.EnumValue, CASActionOptions.FORMAT| Modifier and Type | Field and Description |
|---|---|
static java.lang.String |
ACTION_NAME |
static java.lang.String |
ACTION_SET_NAME |
static java.lang.String |
KEY_FETCHVARS |
static java.lang.String |
KEY_FORMAT |
static java.lang.String |
KEY_FROM |
static java.lang.String |
KEY_INDEX |
static java.lang.String |
KEY_MAXROWS |
static java.lang.String |
KEY_SASTYPES |
static java.lang.String |
KEY_SORTBY |
static java.lang.String |
KEY_SORTLOCALE |
static java.lang.String |
KEY_TABLE |
static java.lang.String |
KEY_TO |
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 and Description |
|---|
FetchOptions() |
FetchOptions(CASActionOptions options) |
| Modifier and Type | Method and Description |
|---|---|
Casinvardesc[] |
getFetchVars() |
java.lang.Boolean |
getFormat() |
java.lang.Long |
getFrom() |
java.lang.Boolean |
getIndex() |
java.lang.Integer |
getMaxRows() |
Fetchorderbyelement[] |
getOrderBy() |
java.lang.Boolean |
getSasTypes() |
java.lang.Object |
getServerDefaultValue(java.lang.String key)
Gets the server default value, if known.
|
Fetchorderbyelement[] |
getSortBy() |
java.lang.String |
getSortLocale() |
Castable |
getTable() |
java.lang.Long |
getTo() |
FetchOptions |
setFetchVars(Casinvardesc[] value)
Sets the value of parameter 'fetchVars'.
|
FetchOptions |
setFormat(java.lang.Boolean value)
Sets the value of parameter 'format': when set to True, formats are applied to the variables.
|
FetchOptions |
setFrom(java.lang.Long value)
Sets the value of parameter 'from': specifies the ordinal position of the first row to return.
|
FetchOptions |
setIndex(java.lang.Boolean value)
Sets the value of parameter 'index': when set to True, adds a column named Index to the results that is to identify each row.
|
FetchOptions |
setMaxRows(java.lang.Integer value)
Sets the value of parameter 'maxRows': specifies the maximum number of rows to return.
|
FetchOptions |
setOrderBy(Fetchorderbyelement[] value) |
FetchOptions |
setSasTypes(java.lang.Boolean value)
Sets the value of parameter 'sasTypes': when set to True, converts data to fixed-width character and double data types.
|
FetchOptions |
setSortBy(Fetchorderbyelement[] value)
Sets the value of parameter 'sortBy': specifies the variables and variable settings for sorting results.
|
FetchOptions |
setSortLocale(java.lang.String value)
Sets the value of parameter 'sortLocale': locale to use for comparisons during sort.
|
FetchOptions |
setTable(Castable value)
Sets the value of parameter 'table': specifies the table name, caslib, and other common parameters.
|
FetchOptions |
setTo(java.lang.Long value)
Sets the value of parameter 'to': specifies the ordinal position of the last row to return.
|
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, valuespublic static final java.lang.String ACTION_SET_NAME
public static final java.lang.String ACTION_NAME
public static final java.lang.String KEY_TABLE
public static final java.lang.String KEY_FROM
public static final java.lang.String KEY_TO
public static final java.lang.String KEY_FORMAT
public static final java.lang.String KEY_MAXROWS
public static final java.lang.String KEY_SASTYPES
public static final java.lang.String KEY_SORTLOCALE
public static final java.lang.String KEY_SORTBY
public static final java.lang.String KEY_INDEX
public static final java.lang.String KEY_FETCHVARS
public FetchOptions()
public FetchOptions(CASActionOptions options)
public java.lang.Object getServerDefaultValue(java.lang.String key)
CASActionOptionsgetServerDefaultValue in class CASActionOptionskey - The parameter keypublic Castable getTable()
public FetchOptions setTable(Castable value)
value - The valuepublic java.lang.Long getFrom()
public FetchOptions setFrom(java.lang.Long value)
value - The valuepublic java.lang.Long getTo()
public FetchOptions setTo(java.lang.Long value)
value - The valuepublic java.lang.Boolean getFormat()
public FetchOptions setFormat(java.lang.Boolean value)
value - The valuepublic java.lang.Integer getMaxRows()
public FetchOptions setMaxRows(java.lang.Integer value)
value - The valuepublic java.lang.Boolean getSasTypes()
public FetchOptions setSasTypes(java.lang.Boolean value)
value - The valuepublic java.lang.String getSortLocale()
public FetchOptions setSortLocale(java.lang.String value)
value - The valuepublic Fetchorderbyelement[] getSortBy()
public Fetchorderbyelement[] getOrderBy()
public FetchOptions setSortBy(Fetchorderbyelement[] value)
value - The valuepublic FetchOptions setOrderBy(Fetchorderbyelement[] value)
public java.lang.Boolean getIndex()
public FetchOptions setIndex(java.lang.Boolean value)
value - The valuepublic Casinvardesc[] getFetchVars()
public FetchOptions setFetchVars(Casinvardesc[] value)
value - The value