Platform SDK Java 8.5 API Reference

com.genesyslab.platform.outbound.protocol.outboundserver.events
Class EventCampaignUnloaded

java.lang.Object
  extended by com.genesyslab.platform.commons.protocol.DataObject
      extended by com.genesyslab.platform.commons.protocol.Message
          extended by com.genesyslab.platform.outbound.protocol.outboundserver.events.EventCampaignUnloaded
All Implemented Interfaces:
ProtocolDescriptionSupport

public abstract class EventCampaignUnloaded
extends Message

The specified campaign has been successfully unloaded.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static EventCampaignUnloaded create()
          Creates instance of EventCampaignUnloaded with no parameters set.
static EventCampaignUnloaded 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 EventCampaignUnloaded 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

ID

public static final int ID
See Also:
Constant Field Values

NAME

public static final java.lang.String NAME
See Also:
Constant Field Values
Method Detail

create

public static EventCampaignUnloaded create()
Creates instance of EventCampaignUnloaded with no parameters set.

Returns:
instance of EventCampaignUnloaded

create

public static EventCampaignUnloaded 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 EventCampaignUnloaded with all parameters set.

Parameters:
requestId - Contains the reference ID of the request to which the current event is a response
campaignId - The configuration environment DBID of the current campaign
groupId - The configuration environment DBID of the agent group
dialMode - The dialing mode
optimizeGoal - The optimization goal
groupCampaignStatus - The current group campaign status
optimizeBy - The optimization method
requestProperties - A KeyValue list of additional information passed to the request
errorMessage - The error message describing the current error condition
errorCode - The error code of the current error condition
scheduleScriptId - 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).
Returns:
instance of EventCampaignUnloaded

getReferenceId

public abstract java.lang.Integer getReferenceId()
The reference id by which requests are associated with corresponding events.


setReferenceId

public abstract void setReferenceId(java.lang.Integer referenceId)
The reference id by which requests are associated with corresponding events.


setReferenceId

public abstract void setReferenceId(int referenceId)
The reference id by which requests are associated with corresponding events.


getRequestId

public abstract java.lang.Integer getRequestId()
Contains the reference ID of the request to which the current event is a response

Returns:
property value

setRequestId

public abstract void setRequestId(java.lang.Integer requestId)
Contains the reference ID of the request to which the current event is a response

Parameters:
requestId - new value of the property

setRequestId

public abstract void setRequestId(int requestId)
Contains the reference ID of the request to which the current event is a response

Parameters:
requestId - new value of the property

getCampaignId

public abstract java.lang.Integer getCampaignId()
The configuration environment DBID of the current campaign

Returns:
property value

setCampaignId

public abstract void setCampaignId(java.lang.Integer campaignId)
The configuration environment DBID of the current campaign

Parameters:
campaignId - new value of the property

setCampaignId

public abstract void setCampaignId(int campaignId)
The configuration environment DBID of the current campaign

Parameters:
campaignId - new value of the property

getGroupId

public abstract java.lang.Integer getGroupId()
The configuration environment DBID of the agent group

Returns:
property value

setGroupId

public abstract void setGroupId(java.lang.Integer groupId)
The configuration environment DBID of the agent group

Parameters:
groupId - new value of the property

setGroupId

public abstract void setGroupId(int groupId)
The configuration environment DBID of the agent group

Parameters:
groupId - new value of the property

getDialMode

public abstract DialMode getDialMode()
The dialing mode

Returns:
property value

setDialMode

public abstract void setDialMode(DialMode dialMode)
The dialing mode

Parameters:
dialMode - new value of the property

getOptimizeGoal

public abstract java.lang.Integer getOptimizeGoal()
The optimization goal

Returns:
property value

setOptimizeGoal

public abstract void setOptimizeGoal(java.lang.Integer optimizeGoal)
The optimization goal

Parameters:
optimizeGoal - new value of the property

setOptimizeGoal

public abstract void setOptimizeGoal(int optimizeGoal)
The optimization goal

Parameters:
optimizeGoal - new value of the property

getGroupCampaignStatus

public abstract GroupCampaignStatus getGroupCampaignStatus()
The current group campaign status

Returns:
property value

setGroupCampaignStatus

public abstract void setGroupCampaignStatus(GroupCampaignStatus groupCampaignStatus)
The current group campaign status

Parameters:
groupCampaignStatus - new value of the property

getOptimizeBy

public abstract OptimizationMethod getOptimizeBy()
The optimization method

Returns:
property value

setOptimizeBy

public abstract void setOptimizeBy(OptimizationMethod optimizeBy)
The optimization method

Parameters:
optimizeBy - new value of the property

getRequestProperties

public abstract KeyValueCollection getRequestProperties()
A KeyValue list of additional information passed to the request

Returns:
property value

setRequestProperties

public abstract void setRequestProperties(KeyValueCollection requestProperties)
A KeyValue list of additional information passed to the request

Parameters:
requestProperties - new value of the property

getErrorMessage

public abstract java.lang.String getErrorMessage()
The error message describing the current error condition

Returns:
property value

setErrorMessage

public abstract void setErrorMessage(java.lang.String errorMessage)
The error message describing the current error condition

Parameters:
errorMessage - new value of the property

getErrorCode

public abstract java.lang.Integer getErrorCode()
The error code of the current error condition

Returns:
property value

setErrorCode

public abstract void setErrorCode(java.lang.Integer errorCode)
The error code of the current error condition

Parameters:
errorCode - new value of the property

setErrorCode

public abstract void setErrorCode(int errorCode)
The error code of the current error condition

Parameters:
errorCode - new value of the property

getScheduleScriptId

public abstract java.lang.Integer getScheduleScriptId()
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).

Returns:
property value

setScheduleScriptId

public abstract void setScheduleScriptId(java.lang.Integer scheduleScriptId)
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).

Parameters:
scheduleScriptId - new value of the property

setScheduleScriptId

public abstract void setScheduleScriptId(int scheduleScriptId)
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).

Parameters:
scheduleScriptId - new value of the property

Platform SDK Java 8.5 API Reference

Send comments on this topicTechpubs.webadmin@genesys.com.
Document version: 8.5.302.00
Copyright © 2006–2017 Genesys Telecommunications Laboratories, Inc. All rights reserved.