|
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<CfgCampaign>
com.genesyslab.platform.applicationblocks.com.queries.CfgCampaignQuery
public class CfgCampaignQuery
Class designed to construct queries to the Configuration Service for reading CfgCampaign object(s).
ConfService
,
CfgCampaign
Constructor Summary | |
---|---|
CfgCampaignQuery()
Create query object with default filter value for configuration objects of CfgCampaign type. |
|
CfgCampaignQuery(IConfService service)
Create query object with default filter value for configuration objects of CfgCampaign type. |
|
CfgCampaignQuery(int dbid)
Create query object with filter initialized for the object DBID. |
|
CfgCampaignQuery(java.lang.String name)
Create query object with filter initialized for object name value. |
Method Summary | |
---|---|
AsyncRequestResult<CfgCampaign> |
beginExecute(Action<AsyncRequestResult<CfgCampaign>> callback,
java.lang.Object state)
Begins the asynchronous execution of the current query. |
java.util.Collection<CfgCampaign> |
execute()
Executes the query and returns a list of CfgCampaign objects. |
CfgCampaign |
executeSingleResult()
Executes a query the result of which is a single object. |
int |
getCallingListDbid()
A unique identifier of calling list. |
int |
getDbid()
A unique identifier of the campaign. |
int |
getGroupDbid()
A unique identifier of group . If
specified, Configuration Server will return information only about
the campaign(s) with that group. |
java.lang.String |
getName()
Name of a campaign. |
int |
getScriptDbid()
A unique identifier of the campaign script. |
CfgObjectState |
getState()
Current state of the campaign (See
CfgObjectState
). |
int |
getTenantDbid()
A unique identifier of the tenant. |
void |
setCallingListDbid(int value)
A unique identifier of calling list. |
void |
setDbid(int value)
A unique identifier of the campaign. |
void |
setGroupDbid(int value)
A unique identifier of group . If
specified, Configuration Server will return information only about
the campaign(s) with that group. |
void |
setName(java.lang.String value)
Name of a campaign. |
void |
setScriptDbid(int value)
A unique identifier of the campaign script. |
void |
setState(CfgObjectState value)
Current state of the campaign (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 CfgCampaignQuery()
public CfgCampaignQuery(IConfService service)
service
- The configuration service to use when executing this querypublic CfgCampaignQuery(int dbid)
dbid
- value for filter on object dbidsetDbid(int)
public CfgCampaignQuery(java.lang.String name)
name
- value for filter on object namesetName(String)
Method Detail |
---|
public CfgCampaign executeSingleResult() throws ConfigException
executeSingleResult
in class CfgQuery<CfgCampaign>
ConfigException
public java.util.Collection<CfgCampaign> execute() throws ConfigException, java.lang.InterruptedException
execute
in class CfgQuery<CfgCampaign>
ConfigException
java.lang.InterruptedException
public AsyncRequestResult<CfgCampaign> beginExecute(Action<AsyncRequestResult<CfgCampaign>> 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(s) with that group.
value
- filter value on field "group_dbid".public final int getGroupDbid()
.
If
specified, Configuration Server will return information only about
the campaign(s) with that group.
setGroupDbid(int)
public final void setCallingListDbid(int value)
value
- filter value on field "calling_list_dbid".public final int getCallingListDbid()
setCallingListDbid(int)
public final void setScriptDbid(int value)
value
- filter value on field "script_dbid".public final int getScriptDbid()
setScriptDbid(int)
public final void setState(CfgObjectState value)
CfgObjectState
). If specified, Configuration Server
will return information only about the campaign(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(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 |