Platform SDK Java 8.5 API Reference

com.genesyslab.platform.outbound.protocol.outboundserver.requests
Class RequestStartDialing

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.requests.RequestStartDialing
All Implemented Interfaces:
ProtocolDescriptionSupport

public abstract class RequestStartDialing
extends Message

Causes dialing operations for the current campaign to begin.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static RequestStartDialing create()
          Creates instance of RequestStartDialing with no parameters set.
static RequestStartDialing create(java.lang.Integer campaignId, java.lang.Integer groupId, java.lang.Integer sessionId, DialMode dialMode, OptimizationMethod optimizeBy, java.lang.Integer optimizeGoal, KeyValueCollection requestProperties)
          Creates instance of RequestStartDialing 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 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  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 setDialMode(DialMode dialMode)
          The dialing mode
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 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

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 RequestStartDialing create()
Creates instance of RequestStartDialing with no parameters set.

Returns:
instance of RequestStartDialing

create

public static RequestStartDialing create(java.lang.Integer campaignId,
                                         java.lang.Integer groupId,
                                         java.lang.Integer sessionId,
                                         DialMode dialMode,
                                         OptimizationMethod optimizeBy,
                                         java.lang.Integer optimizeGoal,
                                         KeyValueCollection requestProperties)
Creates instance of RequestStartDialing with all parameters set.

Parameters:
campaignId - The configuration environment DBID of the current campaign
groupId - The configuration environment DBID of the agent group
sessionId - DBID of the Campaign Group
dialMode - The dialing mode
optimizeBy - The optimization method
optimizeGoal - The optimization goal
requestProperties - A KeyValue list of additional information passed to the request
Returns:
instance of RequestStartDialing

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.


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

getSessionId

public abstract java.lang.Integer getSessionId()
DBID of the Campaign Group

Returns:
property value

setSessionId

public abstract void setSessionId(java.lang.Integer sessionId)
DBID of the Campaign Group

Parameters:
sessionId - new value of the property

setSessionId

public abstract void setSessionId(int sessionId)
DBID of the Campaign Group

Parameters:
sessionId - 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

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

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

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

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.