|
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<CfgCampaignGroup>
com.genesyslab.platform.applicationblocks.com.queries.CfgCampaignGroupQuery
public class CfgCampaignGroupQuery
Class designed to construct queries to the Configuration Service for reading CfgCampaignGroup object(s).
ConfService
,
CfgCampaignGroup
Constructor Summary | |
---|---|
CfgCampaignGroupQuery()
Create query object with default filter value for configuration objects of CfgCampaignGroup type. |
|
CfgCampaignGroupQuery(IConfService service)
Create query object with default filter value for configuration objects of CfgCampaignGroup type. |
|
CfgCampaignGroupQuery(int dbid)
Create query object with filter initialized for the object DBID. |
|
CfgCampaignGroupQuery(java.lang.String name)
Create query object with filter initialized for object name value. |
Method Summary | |
---|---|
AsyncRequestResult<CfgCampaignGroup> |
beginExecute(Action<AsyncRequestResult<CfgCampaignGroup>> callback,
java.lang.Object state)
Begins the asynchronous execution of the current query. |
java.util.Collection<CfgCampaignGroup> |
execute()
Executes the query and returns a list of CfgCampaignGroup objects. |
CfgCampaignGroup |
executeSingleResult()
Executes a query the result of which is a single object. |
int |
getCampaignDbid()
A unique identifier of camapign. |
int |
getDbid()
A unique identifier of the calling list. |
int |
getGroupDbid()
A unique identifier of group . If
specified, Configuration Server will return information only about
the campaign group(s) related to that (Agent or Place) group |
java.lang.String |
getName()
Name of a calling list. |
CfgObjectState |
getState()
Current state of the campaign group (See
CfgObjectState
). |
int |
getTenantDbid()
A unique identifier of the tenant. |
void |
setCampaignDbid(int value)
A unique identifier of camapign. |
void |
setDbid(int value)
A unique identifier of the calling list. |
void |
setGroupDbid(int value)
A unique identifier of group . If
specified, Configuration Server will return information only about
the campaign group(s) related to that (Agent or Place) group |
void |
setName(java.lang.String value)
Name of a calling list. |
void |
setState(CfgObjectState value)
Current state of the campaign group (See
CfgObjectState
). |
void |
setTenantDbid(int value)
A unique identifier of the 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 CfgCampaignGroupQuery()
public CfgCampaignGroupQuery(IConfService service)
service
- The configuration service to use when executing this querypublic CfgCampaignGroupQuery(int dbid)
dbid
- value for filter on object dbidsetDbid(int)
public CfgCampaignGroupQuery(java.lang.String name)
name
- value for filter on object namesetName(String)
Method Detail |
---|
public CfgCampaignGroup executeSingleResult() throws ConfigException
executeSingleResult
in class CfgQuery<CfgCampaignGroup>
ConfigException
public java.util.Collection<CfgCampaignGroup> execute() throws ConfigException, java.lang.InterruptedException
execute
in class CfgQuery<CfgCampaignGroup>
ConfigException
java.lang.InterruptedException
public AsyncRequestResult<CfgCampaignGroup> beginExecute(Action<AsyncRequestResult<CfgCampaignGroup>> 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 setDbid(int value)
value
- filter value on field "dbid".public final int getDbid()
setDbid(int)
public final void setTenantDbid(int value)
value
- filter value on field "tenant_dbid".public final int getTenantDbid()
setTenantDbid(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 setGroupDbid(int value)
.
If
specified, Configuration Server will return information only about
the campaign group(s) related to that (Agent or Place) group
value
- filter value on field "group_dbid".public final int getGroupDbid()
.
If
specified, Configuration Server will return information only about
the campaign group(s) related to that (Agent or Place) group
setGroupDbid(int)
public final void setCampaignDbid(int value)
value
- filter value on field "campaign_dbid".public final int getCampaignDbid()
setCampaignDbid(int)
public final void setState(CfgObjectState value)
CfgObjectState
). If specified, Configuration Server
will return information only about the campaign group(s) 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 the campaign group(s) that are currently
in this state.
setState(CfgObjectState)
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |