|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.genesyslab.platform.applicationblocks.com.CfgQuery<TT>
com.genesyslab.platform.applicationblocks.com.CfgFilterBasedQuery<CfgScript>
com.genesyslab.platform.applicationblocks.com.queries.CfgScriptQuery
public class CfgScriptQuery
Class designed to construct queries to the Configuration Service for reading CfgScript object(s).
ConfService
,
CfgScript
Constructor Summary | |
---|---|
CfgScriptQuery()
Create query object with default filter value for configuration objects of CfgScript type. |
|
CfgScriptQuery(IConfService service)
Create query object with default filter value for configuration objects of CfgScript type. |
|
CfgScriptQuery(int dbid)
Create query object with filter initialized for the object DBID. |
|
CfgScriptQuery(java.lang.String name)
Create query object with filter initialized for object name value. |
Method Summary | |
---|---|
AsyncRequestResult<CfgScript> |
beginExecute(Action<AsyncRequestResult<CfgScript>> callback,
java.lang.Object state)
Begins the asynchronous execution of the current query. |
java.util.Collection<CfgScript> |
execute()
Executes the query and returns a list of CfgScript objects. |
CfgScript |
executeSingleResult()
Executes a query the result of which is a single object. |
int |
getCapacityAgentDbid()
A unique identifier of Person/Agent. |
int |
getCapacityAgentGroupDbid()
Unique identifier of an AgentGroup. |
int |
getCapacityPlaceDbid()
Unique identifier of a Place. |
int |
getCapacityPlaceGroupDbid()
Unique identifier of a PlaceGroup. |
int |
getCapacityTenantDbid()
A unique identifier of Tenant. |
int |
getDbid()
A unique identifier of a script. |
int |
getExcludeBytecode()
A flag controlling how the bytecode
binary option from the userProperties field will be returned. |
int |
getExcludeLongstrings()
A flag controlling how the string options longer that 255 chars userProperties field ( or options for objects that support them) field will be returned. |
java.lang.String |
getName()
Name of a script. |
CfgScriptType |
getScriptType()
Type of the script (see
CfgScriptType
). |
CfgObjectState |
getState()
Current state of a script (see
CfgObjectState
). |
int |
getTenantDbid()
A unique identifier of a tenant. |
void |
setCapacityAgentDbid(int value)
A unique identifier of Person/Agent. |
void |
setCapacityAgentGroupDbid(int value)
Unique identifier of an AgentGroup. |
void |
setCapacityPlaceDbid(int value)
Unique identifier of a Place. |
void |
setCapacityPlaceGroupDbid(int value)
Unique identifier of a PlaceGroup. |
void |
setCapacityTenantDbid(int value)
A unique identifier of Tenant. |
void |
setDbid(int value)
A unique identifier of a script. |
void |
setExcludeBytecode(int value)
A flag controlling how the bytecode
binary option from the userProperties field will be returned. |
void |
setExcludeLongstrings(int value)
A flag controlling how the string options longer that 255 chars userProperties field ( or options for objects that support them) field will be returned. |
void |
setName(java.lang.String value)
Name of a script. |
void |
setScriptType(CfgScriptType value)
Type of the script (see
CfgScriptType
). |
void |
setState(CfgObjectState value)
Current state of a script (see
CfgObjectState
). |
void |
setTenantDbid(int value)
A unique identifier of a tenant. |
Methods inherited from class com.genesyslab.platform.applicationblocks.com.CfgFilterBasedQuery |
---|
equals, getCfgObjectClass, getCfgObjectType, getDoRequestFolderId, getDoRequestObjectPath, getExtraFilter, getFilter, getInt, getProperty, getQueryObjectClass, getString, hashCode, setDoRequestFolderId, setDoRequestObjectPath, setObjectClass, setProperty, toString |
Methods inherited from class com.genesyslab.platform.applicationblocks.com.CfgQuery |
---|
beginExecute, endExecute, execute, executeSingleResult |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface com.genesyslab.platform.applicationblocks.com.ICfgQuery |
---|
beginExecute, endExecute, execute, executeSingleResult |
Constructor Detail |
---|
public CfgScriptQuery()
public CfgScriptQuery(IConfService service)
service
- The configuration service to use when executing this querypublic CfgScriptQuery(int dbid)
dbid
- value for filter on object dbidsetDbid(int)
public CfgScriptQuery(java.lang.String name)
name
- value for filter on object namesetName(String)
Method Detail |
---|
public CfgScript executeSingleResult() throws ConfigException
executeSingleResult
in class CfgQuery<CfgScript>
ConfigException
public java.util.Collection<CfgScript> execute() throws ConfigException, java.lang.InterruptedException
execute
in class CfgQuery<CfgScript>
ConfigException
java.lang.InterruptedException
public AsyncRequestResult<CfgScript> beginExecute(Action<AsyncRequestResult<CfgScript>> callback, java.lang.Object state) throws ConfigException
callback
- The method to be called when query results are availablestate
- a user-defined object that qualifies or contains information about an asynchronous operation
ConfigException
public final void setTenantDbid(int value)
value
- filter value on field "tenant_dbid".public final int getTenantDbid()
setTenantDbid(int)
public final void setScriptType(CfgScriptType value)
CfgScriptType
).
If specified, Configuration Server will return information only
about the script(s) of this type.
value
- filter value on field "script_type".public final CfgScriptType getScriptType()
CfgScriptType
).
If specified, Configuration Server will return information only
about the script(s) of this type.
setScriptType(CfgScriptType)
public final void setState(CfgObjectState value)
CfgObjectState
). If specified, Configuration Server
will return information only about scripts that are currently in
this state.
value
- filter value on field "state".public final CfgObjectState getState()
CfgObjectState
). If specified, Configuration Server
will return information only about scripts that are currently in
this state.
setState(CfgObjectState)
public final void setDbid(int value)
value
- filter value on field "dbid".public final int getDbid()
setDbid(int)
public final void setName(java.lang.String value)
value
- filter value on field "name".public final java.lang.String getName()
setName(String)
public final void setCapacityTenantDbid(int value)
value
- filter value on field "capacity_tenant_dbid".public final int getCapacityTenantDbid()
setCapacityTenantDbid(int)
public final void setCapacityAgentDbid(int value)
value
- filter value on field "capacity_agent_dbid".public final int getCapacityAgentDbid()
setCapacityAgentDbid(int)
public final void setCapacityAgentGroupDbid(int value)
value
- filter value on field "capacity_agent_group_dbid".public final int getCapacityAgentGroupDbid()
setCapacityAgentGroupDbid(int)
public final void setCapacityPlaceDbid(int value)
value
- filter value on field "capacity_place_dbid".public final int getCapacityPlaceDbid()
setCapacityPlaceDbid(int)
public final void setCapacityPlaceGroupDbid(int value)
value
- filter value on field "capacity_place_group_dbid".public final int getCapacityPlaceGroupDbid()
setCapacityPlaceGroupDbid(int)
public final void setExcludeBytecode(int value)
bytecode
binary option from the userProperties
field will be returned. If
set in the filter, Configuration Server will return an empty list under this
option without regard to the actual content.
value
- filter value on field "exclude_bytecode".public final int getExcludeBytecode()
bytecode
binary option from the userProperties
field will be returned. If
set in the filter, Configuration Server will return an empty list under this
option without regard to the actual content.
setExcludeBytecode(int)
public final void setExcludeLongstrings(int value)
userProperties
field ( or options
for objects that support them) field will be returned. If
set in the filter, Configuration Server will return an empty string under this
option if value is changed to more than 255
Note: this option is also applicable to all configuration objects, not only Script
value
- filter value on field "exclude_longstrings".public final int getExcludeLongstrings()
userProperties
field ( or options
for objects that support them) field will be returned. If
set in the filter, Configuration Server will return an empty string under this
option if value is changed to more than 255
Note: this option is also applicable to all configuration objects, not only Script
setExcludeLongstrings(int)
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |