|
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.commons.protocol.DataObject
com.genesyslab.platform.commons.protocol.Message
com.genesyslab.platform.outbound.protocol.outboundserver.requests.RequestForceUnloadCampaign
public abstract class RequestForceUnloadCampaign
Forcibly unloads the specified campaign.
Field Summary | |
---|---|
static int |
ID
|
static java.lang.String |
NAME
|
Method Summary | |
---|---|
static RequestForceUnloadCampaign |
create()
Creates instance of RequestForceUnloadCampaign with no parameters set. |
static RequestForceUnloadCampaign |
create(java.lang.Integer campaignId,
java.lang.Integer groupId,
java.lang.Integer sessionId,
KeyValueCollection requestProperties)
Creates instance of RequestForceUnloadCampaign with all parameters set. |
abstract java.lang.Integer |
getCampaignId()
The configuration environment DBID of the current campaign |
abstract java.lang.Integer |
getGroupId()
The configuration environment DBID of the agent group |
abstract java.lang.Integer |
getReferenceId()
The reference id by which requests are associated with corresponding events. |
abstract KeyValueCollection |
getRequestProperties()
A KeyValue list of additional information passed to the request |
abstract java.lang.Integer |
getSessionId()
DBID of the Campaign Group |
abstract void |
setCampaignId(int campaignId)
The configuration environment DBID of the current campaign |
abstract void |
setCampaignId(java.lang.Integer campaignId)
The configuration environment DBID of the current campaign |
abstract void |
setGroupId(int groupId)
The configuration environment DBID of the agent group |
abstract void |
setGroupId(java.lang.Integer groupId)
The configuration environment DBID of the agent group |
abstract void |
setReferenceId(int referenceId)
The reference id by which requests are associated with corresponding events. |
abstract void |
setReferenceId(java.lang.Integer referenceId)
The reference id by which requests are associated with corresponding events. |
abstract void |
setRequestProperties(KeyValueCollection requestProperties)
A KeyValue list of additional information passed to the request |
abstract void |
setSessionId(int sessionId)
DBID of the Campaign Group |
abstract void |
setSessionId(java.lang.Integer sessionId)
DBID of the Campaign Group |
Methods inherited from class com.genesyslab.platform.commons.protocol.Message |
---|
cloneMessage, getEndpoint, getMessageAttribute, getProtocolDescription, getProtocolId, messageId, messageName, setProtocolDescription |
Methods inherited from class com.genesyslab.platform.commons.protocol.DataObject |
---|
equals, hashCode, toString, toString |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final int ID
public static final java.lang.String NAME
Method Detail |
---|
public static RequestForceUnloadCampaign create()
public static RequestForceUnloadCampaign create(java.lang.Integer campaignId, java.lang.Integer groupId, java.lang.Integer sessionId, KeyValueCollection requestProperties)
campaignId
- The configuration environment DBID of the current campaigngroupId
- The configuration environment DBID of the agent groupsessionId
- DBID of the Campaign GrouprequestProperties
- A KeyValue list of additional information passed to the request
public abstract java.lang.Integer getReferenceId()
public abstract void setReferenceId(java.lang.Integer referenceId)
public abstract void setReferenceId(int referenceId)
public abstract java.lang.Integer getCampaignId()
public abstract void setCampaignId(java.lang.Integer campaignId)
campaignId
- new value of the propertypublic abstract void setCampaignId(int campaignId)
campaignId
- new value of the propertypublic abstract java.lang.Integer getGroupId()
public abstract void setGroupId(java.lang.Integer groupId)
groupId
- new value of the propertypublic abstract void setGroupId(int groupId)
groupId
- new value of the propertypublic abstract java.lang.Integer getSessionId()
public abstract void setSessionId(java.lang.Integer sessionId)
sessionId
- new value of the propertypublic abstract void setSessionId(int sessionId)
sessionId
- new value of the propertypublic abstract KeyValueCollection getRequestProperties()
public abstract void setRequestProperties(KeyValueCollection requestProperties)
requestProperties
- new value of the property
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |