Package co.ecg.alpaca.toolkit.generated

Class RoutePoint.GroupRoutePointAddInstanceRequest

java.lang.Object

co.ecg.alpaca.toolkit.messaging.request.Request<DefaultResponse>

co.ecg.alpaca.toolkit.generated.RoutePoint.GroupRoutePointAddInstanceRequest

Enclosing class:

RoutePoint

public static class RoutePoint.GroupRoutePointAddInstanceRequest
extends Request<DefaultResponse>

Add a Route Point instance to a group. The Route Point is a Call Center queue that performs the same function but allows an external system to perform the distribution of calls instead of making those decisions itself. The domain is required in the serviceUserId. The response is either SuccessResponse or ErrorResponse. The Following elements are only used in AS data mode and ignored in XS data mode: - sendCallAdmissionNotification, use value ‘false’ in XS data mode. - callAdmissionTimerSeconds, use value ‘3’ in XS data mode.

Author:

AlpacaGenerator

Nested Class Summary

Nested classes/interfaces inherited from class co.ecg.alpaca.toolkit.messaging.request.Request

Request.Protocol

Field Summary

Fields

Modifier and Type	Field	Description
protected @NotNull AgentACDAutomaticState	agentStateAfterCall
protected @Size(min=1,max=10) String	agentUnavailableCode
protected @NotNull Integer	callAdmissionTimerSeconds
protected @NotNull Boolean	enableAutomaticStateChangeForAgents
protected Boolean	enableUnlimitedQueueLength
protected @NotNull Boolean	enableVideo
protected @NotNull AudioFileCodec22	externalPreferredAudioCodec
protected @NotNull Boolean	forceDeliveryOfCalls
protected Integer	forceDeliveryWaitTimeSeconds
protected @NotNull @Size(min=1,max=30) String	groupId
protected @NotNull AudioFileCodec22	internalPreferredAudioCodec
protected @Size(min=1,max=40) String	networkClassOfService
protected @NotNull Integer	noAnswerTimeoutRings
protected @NotNull Boolean	overrideAgentWrapUpTime
protected @NotNull Boolean	playRingingWhenOfferingCall
protected @NotNull Integer	queueLength
protected @NotNull Boolean	sendCallAdmissionNotification
protected @NotNull @Valid ServiceInstanceAddProfile	serviceInstanceProfile
protected @NotNull @Size(min=1,max=30) String	serviceProviderId
protected @NotNull @Size(min=1,max=161) String	serviceUserId
protected Integer	wrapUpSeconds

Fields inherited from class co.ecg.alpaca.toolkit.messaging.request.Request

log

Constructor Summary

Constructors

Constructor	Description
GroupRoutePointAddInstanceRequest()
GroupRoutePointAddInstanceRequest(BroadWorksServer broadWorksServer, String serviceProviderId, String groupId, String serviceUserId, ServiceInstanceAddProfile serviceInstanceProfile, AudioFileCodec22 externalPreferredAudioCodec, AudioFileCodec22 internalPreferredAudioCodec, Integer queueLength, Integer noAnswerTimeoutRings, Boolean enableVideo, Boolean playRingingWhenOfferingCall, Boolean overrideAgentWrapUpTime, Boolean enableAutomaticStateChangeForAgents, AgentACDAutomaticState agentStateAfterCall, Boolean forceDeliveryOfCalls, Boolean sendCallAdmissionNotification, Integer callAdmissionTimerSeconds)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
AgentACDAutomaticState	getAgentStateAfterCall()
String	getAgentUnavailableCode()
Integer	getCallAdmissionTimerSeconds()
static RoutePoint.GroupRoutePointAddInstanceRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
Boolean	getEnableAutomaticStateChangeForAgents()
Boolean	getEnableUnlimitedQueueLength()
Boolean	getEnableVideo()
AudioFileCodec22	getExternalPreferredAudioCodec()
Boolean	getForceDeliveryOfCalls()
Integer	getForceDeliveryWaitTimeSeconds()
String	getGroupId()
AudioFileCodec22	getInternalPreferredAudioCodec()
String	getNetworkClassOfService()
Integer	getNoAnswerTimeoutRings()
Boolean	getOverrideAgentWrapUpTime()
Boolean	getPlayRingingWhenOfferingCall()
Integer	getQueueLength()
Boolean	getSendCallAdmissionNotification()
ServiceInstanceAddProfile	getServiceInstanceProfile()
String	getServiceProviderId()
String	getServiceUserId()
Integer	getWrapUpSeconds()
RoutePoint.GroupRoutePointAddInstanceRequest	setAgentStateAfterCall(AgentACDAutomaticState agentStateAfterCall)
RoutePoint.GroupRoutePointAddInstanceRequest	setAgentUnavailableCode(String agentUnavailableCode)
RoutePoint.GroupRoutePointAddInstanceRequest	setCallAdmissionTimerSeconds(Integer callAdmissionTimerSeconds)
RoutePoint.GroupRoutePointAddInstanceRequest	setEnableAutomaticStateChangeForAgents(Boolean enableAutomaticStateChangeForAgents)
RoutePoint.GroupRoutePointAddInstanceRequest	setEnableUnlimitedQueueLength(Boolean enableUnlimitedQueueLength)
RoutePoint.GroupRoutePointAddInstanceRequest	setEnableVideo(Boolean enableVideo)
RoutePoint.GroupRoutePointAddInstanceRequest	setExternalPreferredAudioCodec(AudioFileCodec22 externalPreferredAudioCodec)
RoutePoint.GroupRoutePointAddInstanceRequest	setForceDeliveryOfCalls(Boolean forceDeliveryOfCalls)
RoutePoint.GroupRoutePointAddInstanceRequest	setForceDeliveryWaitTimeSeconds(Integer forceDeliveryWaitTimeSeconds)
RoutePoint.GroupRoutePointAddInstanceRequest	setGroupId(String groupId)
RoutePoint.GroupRoutePointAddInstanceRequest	setInternalPreferredAudioCodec(AudioFileCodec22 internalPreferredAudioCodec)
RoutePoint.GroupRoutePointAddInstanceRequest	setNetworkClassOfService(String networkClassOfService)
RoutePoint.GroupRoutePointAddInstanceRequest	setNoAnswerTimeoutRings(Integer noAnswerTimeoutRings)
RoutePoint.GroupRoutePointAddInstanceRequest	setOverrideAgentWrapUpTime(Boolean overrideAgentWrapUpTime)
RoutePoint.GroupRoutePointAddInstanceRequest	setPlayRingingWhenOfferingCall(Boolean playRingingWhenOfferingCall)
RoutePoint.GroupRoutePointAddInstanceRequest	setQueueLength(Integer queueLength)
RoutePoint.GroupRoutePointAddInstanceRequest	setSendCallAdmissionNotification(Boolean sendCallAdmissionNotification)
RoutePoint.GroupRoutePointAddInstanceRequest	setServiceInstanceProfile(ServiceInstanceAddProfile serviceInstanceProfile)
RoutePoint.GroupRoutePointAddInstanceRequest	setServiceProviderId(String serviceProviderId)
RoutePoint.GroupRoutePointAddInstanceRequest	setServiceUserId(String serviceUserId)
RoutePoint.GroupRoutePointAddInstanceRequest	setWrapUpSeconds(Integer wrapUpSeconds)

Methods inherited from class co.ecg.alpaca.toolkit.messaging.request.Request

appendChild, appendChild, appendChild, asyncFire, createElement, createNilElement, createNilElement, createTextElement, equals, fire, fire, getBroadWorksServer, getCacheString, getCommandElement, getCommandType, getDomDocument, getId, getOCSProtocol, getRequestTimeoutMillis, getResponseClass, getRetries, getRetryCodes, getRootElement, getValidationErrorsAsString, hashCode, isMemberOfBundle, isValid, setBroadWorksServer, setCommandElement, setCommandType, setDomDocument, setEcho, setMemberOfBundle, setRequestId, setRequestTimeoutMillis, setResponseClass, setRetries, setRetryCodes, setRootElement, toString, validate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

serviceProviderId

@NotNull
@Size(min=1,
      max=30)
protected @NotNull @Size(min=1,max=30) String serviceProviderId

groupId

@NotNull
@Size(min=1,
      max=30)
protected @NotNull @Size(min=1,max=30) String groupId

serviceUserId

@NotNull
@Size(min=1,
      max=161)
protected @NotNull @Size(min=1,max=161) String serviceUserId

serviceInstanceProfile

@NotNull
@Valid
protected @NotNull @Valid ServiceInstanceAddProfile serviceInstanceProfile

networkClassOfService

@Size(min=1,
      max=40)
protected @Size(min=1,max=40) String networkClassOfService

externalPreferredAudioCodec

@NotNull
protected @NotNull AudioFileCodec22 externalPreferredAudioCodec

internalPreferredAudioCodec

@NotNull
protected @NotNull AudioFileCodec22 internalPreferredAudioCodec

queueLength

@NotNull
protected @NotNull Integer queueLength

noAnswerTimeoutRings

@NotNull
protected @NotNull Integer noAnswerTimeoutRings

enableVideo

@NotNull
protected @NotNull Boolean enableVideo

playRingingWhenOfferingCall

@NotNull
protected @NotNull Boolean playRingingWhenOfferingCall

overrideAgentWrapUpTime

@NotNull
protected @NotNull Boolean overrideAgentWrapUpTime

wrapUpSeconds

protected Integer wrapUpSeconds

enableAutomaticStateChangeForAgents

@NotNull
protected @NotNull Boolean enableAutomaticStateChangeForAgents

agentStateAfterCall

@NotNull
protected @NotNull AgentACDAutomaticState agentStateAfterCall

agentUnavailableCode

@Size(min=1,
      max=10)
protected @Size(min=1,max=10) String agentUnavailableCode

forceDeliveryOfCalls

@NotNull
protected @NotNull Boolean forceDeliveryOfCalls

forceDeliveryWaitTimeSeconds

protected Integer forceDeliveryWaitTimeSeconds

sendCallAdmissionNotification

@NotNull
protected @NotNull Boolean sendCallAdmissionNotification

callAdmissionTimerSeconds

@NotNull
protected @NotNull Integer callAdmissionTimerSeconds

enableUnlimitedQueueLength

protected Boolean enableUnlimitedQueueLength

Constructor Detail

GroupRoutePointAddInstanceRequest

public GroupRoutePointAddInstanceRequest()

GroupRoutePointAddInstanceRequest

public GroupRoutePointAddInstanceRequest(BroadWorksServer broadWorksServer,
                                         String serviceProviderId,
                                         String groupId,
                                         String serviceUserId,
                                         ServiceInstanceAddProfile serviceInstanceProfile,
                                         AudioFileCodec22 externalPreferredAudioCodec,
                                         AudioFileCodec22 internalPreferredAudioCodec,
                                         Integer queueLength,
                                         Integer noAnswerTimeoutRings,
                                         Boolean enableVideo,
                                         Boolean playRingingWhenOfferingCall,
                                         Boolean overrideAgentWrapUpTime,
                                         Boolean enableAutomaticStateChangeForAgents,
                                         AgentACDAutomaticState agentStateAfterCall,
                                         Boolean forceDeliveryOfCalls,
                                         Boolean sendCallAdmissionNotification,
                                         Integer callAdmissionTimerSeconds)

Method Detail

setServiceProviderId

public RoutePoint.GroupRoutePointAddInstanceRequest setServiceProviderId(String serviceProviderId)

getServiceProviderId

public String getServiceProviderId()

setGroupId

public RoutePoint.GroupRoutePointAddInstanceRequest setGroupId(String groupId)

getGroupId

public String getGroupId()

setServiceUserId

public RoutePoint.GroupRoutePointAddInstanceRequest setServiceUserId(String serviceUserId)

getServiceUserId

public String getServiceUserId()

setServiceInstanceProfile

public RoutePoint.GroupRoutePointAddInstanceRequest setServiceInstanceProfile(ServiceInstanceAddProfile serviceInstanceProfile)

getServiceInstanceProfile

public ServiceInstanceAddProfile getServiceInstanceProfile()

setNetworkClassOfService

public RoutePoint.GroupRoutePointAddInstanceRequest setNetworkClassOfService(String networkClassOfService)

getNetworkClassOfService

public String getNetworkClassOfService()

setExternalPreferredAudioCodec

public RoutePoint.GroupRoutePointAddInstanceRequest setExternalPreferredAudioCodec(AudioFileCodec22 externalPreferredAudioCodec)

getExternalPreferredAudioCodec

public AudioFileCodec22 getExternalPreferredAudioCodec()

setInternalPreferredAudioCodec

public RoutePoint.GroupRoutePointAddInstanceRequest setInternalPreferredAudioCodec(AudioFileCodec22 internalPreferredAudioCodec)

getInternalPreferredAudioCodec

public AudioFileCodec22 getInternalPreferredAudioCodec()

setQueueLength

public RoutePoint.GroupRoutePointAddInstanceRequest setQueueLength(Integer queueLength)

getQueueLength

public Integer getQueueLength()

setNoAnswerTimeoutRings

public RoutePoint.GroupRoutePointAddInstanceRequest setNoAnswerTimeoutRings(Integer noAnswerTimeoutRings)

getNoAnswerTimeoutRings

public Integer getNoAnswerTimeoutRings()

setEnableVideo

public RoutePoint.GroupRoutePointAddInstanceRequest setEnableVideo(Boolean enableVideo)

getEnableVideo

public Boolean getEnableVideo()

setPlayRingingWhenOfferingCall

public RoutePoint.GroupRoutePointAddInstanceRequest setPlayRingingWhenOfferingCall(Boolean playRingingWhenOfferingCall)

getPlayRingingWhenOfferingCall

public Boolean getPlayRingingWhenOfferingCall()

setOverrideAgentWrapUpTime

public RoutePoint.GroupRoutePointAddInstanceRequest setOverrideAgentWrapUpTime(Boolean overrideAgentWrapUpTime)

getOverrideAgentWrapUpTime

public Boolean getOverrideAgentWrapUpTime()

setWrapUpSeconds

public RoutePoint.GroupRoutePointAddInstanceRequest setWrapUpSeconds(Integer wrapUpSeconds)

getWrapUpSeconds

public Integer getWrapUpSeconds()

setEnableAutomaticStateChangeForAgents

public RoutePoint.GroupRoutePointAddInstanceRequest setEnableAutomaticStateChangeForAgents(Boolean enableAutomaticStateChangeForAgents)

getEnableAutomaticStateChangeForAgents

public Boolean getEnableAutomaticStateChangeForAgents()

setAgentStateAfterCall

public RoutePoint.GroupRoutePointAddInstanceRequest setAgentStateAfterCall(AgentACDAutomaticState agentStateAfterCall)

getAgentStateAfterCall

public AgentACDAutomaticState getAgentStateAfterCall()

setAgentUnavailableCode

public RoutePoint.GroupRoutePointAddInstanceRequest setAgentUnavailableCode(String agentUnavailableCode)

getAgentUnavailableCode

public String getAgentUnavailableCode()

setForceDeliveryOfCalls

public RoutePoint.GroupRoutePointAddInstanceRequest setForceDeliveryOfCalls(Boolean forceDeliveryOfCalls)

getForceDeliveryOfCalls

public Boolean getForceDeliveryOfCalls()

setForceDeliveryWaitTimeSeconds

public RoutePoint.GroupRoutePointAddInstanceRequest setForceDeliveryWaitTimeSeconds(Integer forceDeliveryWaitTimeSeconds)

getForceDeliveryWaitTimeSeconds

public Integer getForceDeliveryWaitTimeSeconds()

setSendCallAdmissionNotification

public RoutePoint.GroupRoutePointAddInstanceRequest setSendCallAdmissionNotification(Boolean sendCallAdmissionNotification)

getSendCallAdmissionNotification

public Boolean getSendCallAdmissionNotification()

setCallAdmissionTimerSeconds

public RoutePoint.GroupRoutePointAddInstanceRequest setCallAdmissionTimerSeconds(Integer callAdmissionTimerSeconds)

getCallAdmissionTimerSeconds

public Integer getCallAdmissionTimerSeconds()

setEnableUnlimitedQueueLength

public RoutePoint.GroupRoutePointAddInstanceRequest setEnableUnlimitedQueueLength(Boolean enableUnlimitedQueueLength)

getEnableUnlimitedQueueLength

public Boolean getEnableUnlimitedQueueLength()

getEmptyObject

public static RoutePoint.GroupRoutePointAddInstanceRequest getEmptyObject(BroadWorksServer broadWorksServer)

Retrieves this object with minimal setup.

Parameters:

broadWorksServer - The BroadWorksServer

formRequest

public void formRequest()

Forms the XML Document for this Request Object. Called by the Request upon fire().

Overrides:

formRequest in class Request<DefaultResponse>