|
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.events.EventDialingStarted
public abstract class EventDialingStarted
Dialing operations for the specified campaign have successfully begun.
Field Summary | |
---|---|
static int |
ID
|
static java.lang.String |
NAME
|
Method Summary | |
---|---|
static EventDialingStarted |
create()
Creates instance of EventDialingStarted with no parameters set. |
static EventDialingStarted |
create(java.lang.Integer requestId,
java.lang.Integer campaignId,
java.lang.Integer groupId,
DialMode dialMode,
java.lang.Integer optimizeGoal,
GroupCampaignStatus groupCampaignStatus,
OptimizationMethod optimizeBy,
KeyValueCollection requestProperties,
java.lang.String errorMessage,
java.lang.Integer errorCode,
java.lang.Integer scheduleScriptId)
Creates instance of EventDialingStarted with all parameters set. |
abstract java.lang.Integer |
getCampaignId()
The configuration environment DBID of the current campaign |
abstract DialMode |
getDialMode()
The dialing mode |
abstract java.lang.Integer |
getErrorCode()
The error code of the current error condition |
abstract java.lang.String |
getErrorMessage()
The error message describing the current error condition |
abstract GroupCampaignStatus |
getGroupCampaignStatus()
The current group campaign status |
abstract java.lang.Integer |
getGroupId()
The configuration environment DBID of the agent group |
abstract OptimizationMethod |
getOptimizeBy()
The optimization method |
abstract java.lang.Integer |
getOptimizeGoal()
The optimization goal |
abstract java.lang.Integer |
getReferenceId()
The reference id by which requests are associated with corresponding events. |
abstract java.lang.Integer |
getRequestId()
Contains the reference ID of the request to which the current event is a response |
abstract KeyValueCollection |
getRequestProperties()
A KeyValue list of additional information passed to the request |
abstract java.lang.Integer |
getScheduleScriptId()
Allows clients to know if action over some campaign group (ex. |
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 |
setDialMode(DialMode dialMode)
The dialing mode |
abstract void |
setErrorCode(int errorCode)
The error code of the current error condition |
abstract void |
setErrorCode(java.lang.Integer errorCode)
The error code of the current error condition |
abstract void |
setErrorMessage(java.lang.String errorMessage)
The error message describing the current error condition |
abstract void |
setGroupCampaignStatus(GroupCampaignStatus groupCampaignStatus)
The current group campaign status |
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 |
setOptimizeBy(OptimizationMethod optimizeBy)
The optimization method |
abstract void |
setOptimizeGoal(int optimizeGoal)
The optimization goal |
abstract void |
setOptimizeGoal(java.lang.Integer optimizeGoal)
The optimization goal |
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 |
setRequestId(int requestId)
Contains the reference ID of the request to which the current event is a response |
abstract void |
setRequestId(java.lang.Integer requestId)
Contains the reference ID of the request to which the current event is a response |
abstract void |
setRequestProperties(KeyValueCollection requestProperties)
A KeyValue list of additional information passed to the request |
abstract void |
setScheduleScriptId(int scheduleScriptId)
Allows clients to know if action over some campaign group (ex. |
abstract void |
setScheduleScriptId(java.lang.Integer scheduleScriptId)
Allows clients to know if action over some campaign group (ex. |
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 EventDialingStarted create()
public static EventDialingStarted create(java.lang.Integer requestId, java.lang.Integer campaignId, java.lang.Integer groupId, DialMode dialMode, java.lang.Integer optimizeGoal, GroupCampaignStatus groupCampaignStatus, OptimizationMethod optimizeBy, KeyValueCollection requestProperties, java.lang.String errorMessage, java.lang.Integer errorCode, java.lang.Integer scheduleScriptId)
requestId
- Contains the reference ID of the request to which the current event is a responsecampaignId
- The configuration environment DBID of the current campaigngroupId
- The configuration environment DBID of the agent groupdialMode
- The dialing modeoptimizeGoal
- The optimization goalgroupCampaignStatus
- The current group campaign statusoptimizeBy
- The optimization methodrequestProperties
- A KeyValue list of additional information passed to the requesterrorMessage
- The error message describing the current error conditionerrorCode
- The error code of the current error conditionscheduleScriptId
- Allows clients to know if action over some campaign group (ex. load) has been taken by the schedule (Script DBID = valid DBID of the script of type Outbound Schedule) or manually (Script DBID = 0).
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 getRequestId()
public abstract void setRequestId(java.lang.Integer requestId)
requestId
- new value of the propertypublic abstract void setRequestId(int requestId)
requestId
- new value of the propertypublic 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 DialMode getDialMode()
public abstract void setDialMode(DialMode dialMode)
dialMode
- new value of the propertypublic abstract java.lang.Integer getOptimizeGoal()
public abstract void setOptimizeGoal(java.lang.Integer optimizeGoal)
optimizeGoal
- new value of the propertypublic abstract void setOptimizeGoal(int optimizeGoal)
optimizeGoal
- new value of the propertypublic abstract GroupCampaignStatus getGroupCampaignStatus()
public abstract void setGroupCampaignStatus(GroupCampaignStatus groupCampaignStatus)
groupCampaignStatus
- new value of the propertypublic abstract OptimizationMethod getOptimizeBy()
public abstract void setOptimizeBy(OptimizationMethod optimizeBy)
optimizeBy
- new value of the propertypublic abstract KeyValueCollection getRequestProperties()
public abstract void setRequestProperties(KeyValueCollection requestProperties)
requestProperties
- new value of the propertypublic abstract java.lang.String getErrorMessage()
public abstract void setErrorMessage(java.lang.String errorMessage)
errorMessage
- new value of the propertypublic abstract java.lang.Integer getErrorCode()
public abstract void setErrorCode(java.lang.Integer errorCode)
errorCode
- new value of the propertypublic abstract void setErrorCode(int errorCode)
errorCode
- new value of the propertypublic abstract java.lang.Integer getScheduleScriptId()
public abstract void setScheduleScriptId(java.lang.Integer scheduleScriptId)
scheduleScriptId
- new value of the propertypublic abstract void setScheduleScriptId(int scheduleScriptId)
scheduleScriptId
- 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 |