Package co.ecg.alpaca.toolkit.generated

Class CallCenter.GroupCallCenterAddInstanceRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.CallCenter.GroupCallCenterAddInstanceRequest

Enclosing class:

CallCenter

public static class CallCenter.GroupCallCenterAddInstanceRequest
extends Request<DefaultResponse>

Add a Call Center instance to a group. The domain is required in the serviceUserId. The response is either SuccessResponse or ErrorResponse.

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 AgentACDAutomaticState	agentStateAfterCall
protected @Size(min=1,max=10) String	agentUnavailableCode
protected @NotNull Boolean	allowAgentLogoff
protected @NotNull Boolean	allowCallerToDialEscapeDigit
protected Boolean	allowCallsToAgentsInWrapUp
protected @NotNull Boolean	allowCallWaitingForAgents
protected Boolean	enableAutomaticStateChangeForAgents
protected Boolean	enableReporting
protected @NotNull Boolean	enableVideo
protected @NotNull @Size(max=1) String	escapeDigit
protected @NotNull AudioFileCodec22	externalPreferredAudioCodec
protected 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 Boolean	overrideAgentWrapUpTime
protected @NotNull Boolean	playRingingWhenOfferingCall
protected @NotNull HuntPolicy	policy
protected @NotNull Integer	queueLength
protected @NotNull Boolean	resetCallStatisticsUponEntryInQueue
protected CallCenterRoutingType	routingType
protected @NotNull @Valid ServiceInstanceAddProfileCallCenter	serviceInstanceProfile
protected @NotNull @Size(min=1,max=30) String	serviceProviderId
protected @NotNull @Size(min=1,max=161) String	serviceUserId
protected @NotNull CallCenterType	type
protected Integer	wrapUpSeconds

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

log

Constructor Summary

Constructors

Constructor	Description
GroupCallCenterAddInstanceRequest()
GroupCallCenterAddInstanceRequest(BroadWorksServer broadWorksServer, String serviceProviderId, String groupId, String serviceUserId, ServiceInstanceAddProfileCallCenter serviceInstanceProfile, CallCenterType type, HuntPolicy policy, Boolean enableVideo, Integer queueLength, Boolean allowCallerToDialEscapeDigit, String escapeDigit, Boolean resetCallStatisticsUponEntryInQueue, Boolean allowAgentLogoff, Boolean allowCallWaitingForAgents, AudioFileCodec22 externalPreferredAudioCodec, AudioFileCodec22 internalPreferredAudioCodec, Boolean playRingingWhenOfferingCall)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
AgentACDAutomaticState	getAgentStateAfterCall()
String	getAgentUnavailableCode()
Boolean	getAllowAgentLogoff()
Boolean	getAllowCallerToDialEscapeDigit()
Boolean	getAllowCallsToAgentsInWrapUp()
Boolean	getAllowCallWaitingForAgents()
static CallCenter.GroupCallCenterAddInstanceRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
Boolean	getEnableAutomaticStateChangeForAgents()
Boolean	getEnableReporting()
Boolean	getEnableVideo()
String	getEscapeDigit()
AudioFileCodec22	getExternalPreferredAudioCodec()
Boolean	getForceDeliveryOfCalls()
Integer	getForceDeliveryWaitTimeSeconds()
String	getGroupId()
AudioFileCodec22	getInternalPreferredAudioCodec()
String	getNetworkClassOfService()
Boolean	getOverrideAgentWrapUpTime()
Boolean	getPlayRingingWhenOfferingCall()
HuntPolicy	getPolicy()
Integer	getQueueLength()
Boolean	getResetCallStatisticsUponEntryInQueue()
CallCenterRoutingType	getRoutingType()
ServiceInstanceAddProfileCallCenter	getServiceInstanceProfile()
String	getServiceProviderId()
String	getServiceUserId()
CallCenterType	getType()
Integer	getWrapUpSeconds()
CallCenter.GroupCallCenterAddInstanceRequest	setAgentStateAfterCall(AgentACDAutomaticState agentStateAfterCall)
CallCenter.GroupCallCenterAddInstanceRequest	setAgentUnavailableCode(String agentUnavailableCode)
CallCenter.GroupCallCenterAddInstanceRequest	setAllowAgentLogoff(Boolean allowAgentLogoff)
CallCenter.GroupCallCenterAddInstanceRequest	setAllowCallerToDialEscapeDigit(Boolean allowCallerToDialEscapeDigit)
CallCenter.GroupCallCenterAddInstanceRequest	setAllowCallsToAgentsInWrapUp(Boolean allowCallsToAgentsInWrapUp)
CallCenter.GroupCallCenterAddInstanceRequest	setAllowCallWaitingForAgents(Boolean allowCallWaitingForAgents)
CallCenter.GroupCallCenterAddInstanceRequest	setEnableAutomaticStateChangeForAgents(Boolean enableAutomaticStateChangeForAgents)
CallCenter.GroupCallCenterAddInstanceRequest	setEnableReporting(Boolean enableReporting)
CallCenter.GroupCallCenterAddInstanceRequest	setEnableVideo(Boolean enableVideo)
CallCenter.GroupCallCenterAddInstanceRequest	setEscapeDigit(String escapeDigit)
CallCenter.GroupCallCenterAddInstanceRequest	setExternalPreferredAudioCodec(AudioFileCodec22 externalPreferredAudioCodec)
CallCenter.GroupCallCenterAddInstanceRequest	setForceDeliveryOfCalls(Boolean forceDeliveryOfCalls)
CallCenter.GroupCallCenterAddInstanceRequest	setForceDeliveryWaitTimeSeconds(Integer forceDeliveryWaitTimeSeconds)
CallCenter.GroupCallCenterAddInstanceRequest	setGroupId(String groupId)
CallCenter.GroupCallCenterAddInstanceRequest	setInternalPreferredAudioCodec(AudioFileCodec22 internalPreferredAudioCodec)
CallCenter.GroupCallCenterAddInstanceRequest	setNetworkClassOfService(String networkClassOfService)
CallCenter.GroupCallCenterAddInstanceRequest	setOverrideAgentWrapUpTime(Boolean overrideAgentWrapUpTime)
CallCenter.GroupCallCenterAddInstanceRequest	setPlayRingingWhenOfferingCall(Boolean playRingingWhenOfferingCall)
CallCenter.GroupCallCenterAddInstanceRequest	setPolicy(HuntPolicy policy)
CallCenter.GroupCallCenterAddInstanceRequest	setQueueLength(Integer queueLength)
CallCenter.GroupCallCenterAddInstanceRequest	setResetCallStatisticsUponEntryInQueue(Boolean resetCallStatisticsUponEntryInQueue)
CallCenter.GroupCallCenterAddInstanceRequest	setRoutingType(CallCenterRoutingType routingType)
CallCenter.GroupCallCenterAddInstanceRequest	setServiceInstanceProfile(ServiceInstanceAddProfileCallCenter serviceInstanceProfile)
CallCenter.GroupCallCenterAddInstanceRequest	setServiceProviderId(String serviceProviderId)
CallCenter.GroupCallCenterAddInstanceRequest	setServiceUserId(String serviceUserId)
CallCenter.GroupCallCenterAddInstanceRequest	setType(CallCenterType type)
CallCenter.GroupCallCenterAddInstanceRequest	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, isIgnoreCache, isMemberOfBundle, isValid, setBroadWorksServer, setCommandElement, setCommandType, setDomDocument, setEcho, setIgnoreCache, 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 Details

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 ServiceInstanceAddProfileCallCenter serviceInstanceProfile

type

@NotNull
protected @NotNull CallCenterType type

routingType

protected CallCenterRoutingType routingType

policy

@NotNull
protected @NotNull HuntPolicy policy

enableVideo

@NotNull
protected @NotNull Boolean enableVideo

queueLength

@NotNull
protected @NotNull Integer queueLength

enableReporting

protected Boolean enableReporting

allowCallerToDialEscapeDigit

@NotNull
protected @NotNull Boolean allowCallerToDialEscapeDigit

escapeDigit

@NotNull
@Size(max=1)
protected @NotNull @Size(max=1) String escapeDigit

resetCallStatisticsUponEntryInQueue

@NotNull
protected @NotNull Boolean resetCallStatisticsUponEntryInQueue

allowAgentLogoff

@NotNull
protected @NotNull Boolean allowAgentLogoff

allowCallWaitingForAgents

@NotNull
protected @NotNull Boolean allowCallWaitingForAgents

allowCallsToAgentsInWrapUp

protected Boolean allowCallsToAgentsInWrapUp

overrideAgentWrapUpTime

protected Boolean overrideAgentWrapUpTime

wrapUpSeconds

protected Integer wrapUpSeconds

forceDeliveryOfCalls

protected Boolean forceDeliveryOfCalls

forceDeliveryWaitTimeSeconds

protected Integer forceDeliveryWaitTimeSeconds

enableAutomaticStateChangeForAgents

protected Boolean enableAutomaticStateChangeForAgents

agentStateAfterCall

protected AgentACDAutomaticState agentStateAfterCall

agentUnavailableCode

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

externalPreferredAudioCodec

@NotNull
protected @NotNull AudioFileCodec22 externalPreferredAudioCodec

internalPreferredAudioCodec

@NotNull
protected @NotNull AudioFileCodec22 internalPreferredAudioCodec

playRingingWhenOfferingCall

@NotNull
protected @NotNull Boolean playRingingWhenOfferingCall

networkClassOfService

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

Constructor Details

GroupCallCenterAddInstanceRequest

public GroupCallCenterAddInstanceRequest()

GroupCallCenterAddInstanceRequest

public GroupCallCenterAddInstanceRequest(BroadWorksServer broadWorksServer,
 String serviceProviderId,
 String groupId,
 String serviceUserId,
 ServiceInstanceAddProfileCallCenter serviceInstanceProfile,
 CallCenterType type,
 HuntPolicy policy,
 Boolean enableVideo,
 Integer queueLength,
 Boolean allowCallerToDialEscapeDigit,
 String escapeDigit,
 Boolean resetCallStatisticsUponEntryInQueue,
 Boolean allowAgentLogoff,
 Boolean allowCallWaitingForAgents,
 AudioFileCodec22 externalPreferredAudioCodec,
 AudioFileCodec22 internalPreferredAudioCodec,
 Boolean playRingingWhenOfferingCall)

Method Details

setServiceProviderId

public CallCenter.GroupCallCenterAddInstanceRequest setServiceProviderId(String serviceProviderId)

getServiceProviderId

public String getServiceProviderId()

setGroupId

public CallCenter.GroupCallCenterAddInstanceRequest setGroupId(String groupId)

getGroupId

public String getGroupId()

setServiceUserId

public CallCenter.GroupCallCenterAddInstanceRequest setServiceUserId(String serviceUserId)

getServiceUserId

public String getServiceUserId()

setServiceInstanceProfile

public CallCenter.GroupCallCenterAddInstanceRequest setServiceInstanceProfile(ServiceInstanceAddProfileCallCenter serviceInstanceProfile)

getServiceInstanceProfile

public ServiceInstanceAddProfileCallCenter getServiceInstanceProfile()

setType

public CallCenter.GroupCallCenterAddInstanceRequest setType(CallCenterType type)

getType

public CallCenterType getType()

setRoutingType

public CallCenter.GroupCallCenterAddInstanceRequest setRoutingType(CallCenterRoutingType routingType)

getRoutingType

public CallCenterRoutingType getRoutingType()

setPolicy

public CallCenter.GroupCallCenterAddInstanceRequest setPolicy(HuntPolicy policy)

getPolicy

public HuntPolicy getPolicy()

setEnableVideo

public CallCenter.GroupCallCenterAddInstanceRequest setEnableVideo(Boolean enableVideo)

getEnableVideo

public Boolean getEnableVideo()

setQueueLength

public CallCenter.GroupCallCenterAddInstanceRequest setQueueLength(Integer queueLength)

getQueueLength

public Integer getQueueLength()

setEnableReporting

public CallCenter.GroupCallCenterAddInstanceRequest setEnableReporting(Boolean enableReporting)

getEnableReporting

public Boolean getEnableReporting()

setAllowCallerToDialEscapeDigit

public CallCenter.GroupCallCenterAddInstanceRequest setAllowCallerToDialEscapeDigit(Boolean allowCallerToDialEscapeDigit)

getAllowCallerToDialEscapeDigit

public Boolean getAllowCallerToDialEscapeDigit()

setEscapeDigit

public CallCenter.GroupCallCenterAddInstanceRequest setEscapeDigit(String escapeDigit)

getEscapeDigit

public String getEscapeDigit()

setResetCallStatisticsUponEntryInQueue

public CallCenter.GroupCallCenterAddInstanceRequest setResetCallStatisticsUponEntryInQueue(Boolean resetCallStatisticsUponEntryInQueue)

getResetCallStatisticsUponEntryInQueue

public Boolean getResetCallStatisticsUponEntryInQueue()

setAllowAgentLogoff

public CallCenter.GroupCallCenterAddInstanceRequest setAllowAgentLogoff(Boolean allowAgentLogoff)

getAllowAgentLogoff

public Boolean getAllowAgentLogoff()

setAllowCallWaitingForAgents

public CallCenter.GroupCallCenterAddInstanceRequest setAllowCallWaitingForAgents(Boolean allowCallWaitingForAgents)

getAllowCallWaitingForAgents

public Boolean getAllowCallWaitingForAgents()

setAllowCallsToAgentsInWrapUp

public CallCenter.GroupCallCenterAddInstanceRequest setAllowCallsToAgentsInWrapUp(Boolean allowCallsToAgentsInWrapUp)

getAllowCallsToAgentsInWrapUp

public Boolean getAllowCallsToAgentsInWrapUp()

setOverrideAgentWrapUpTime

public CallCenter.GroupCallCenterAddInstanceRequest setOverrideAgentWrapUpTime(Boolean overrideAgentWrapUpTime)

getOverrideAgentWrapUpTime

public Boolean getOverrideAgentWrapUpTime()

setWrapUpSeconds

public CallCenter.GroupCallCenterAddInstanceRequest setWrapUpSeconds(Integer wrapUpSeconds)

getWrapUpSeconds

public Integer getWrapUpSeconds()

setForceDeliveryOfCalls

public CallCenter.GroupCallCenterAddInstanceRequest setForceDeliveryOfCalls(Boolean forceDeliveryOfCalls)

getForceDeliveryOfCalls

public Boolean getForceDeliveryOfCalls()

setForceDeliveryWaitTimeSeconds

public CallCenter.GroupCallCenterAddInstanceRequest setForceDeliveryWaitTimeSeconds(Integer forceDeliveryWaitTimeSeconds)

getForceDeliveryWaitTimeSeconds

public Integer getForceDeliveryWaitTimeSeconds()

setEnableAutomaticStateChangeForAgents

public CallCenter.GroupCallCenterAddInstanceRequest setEnableAutomaticStateChangeForAgents(Boolean enableAutomaticStateChangeForAgents)

getEnableAutomaticStateChangeForAgents

public Boolean getEnableAutomaticStateChangeForAgents()

setAgentStateAfterCall

public CallCenter.GroupCallCenterAddInstanceRequest setAgentStateAfterCall(AgentACDAutomaticState agentStateAfterCall)

getAgentStateAfterCall

public AgentACDAutomaticState getAgentStateAfterCall()

setAgentUnavailableCode

public CallCenter.GroupCallCenterAddInstanceRequest setAgentUnavailableCode(String agentUnavailableCode)

getAgentUnavailableCode

public String getAgentUnavailableCode()

setExternalPreferredAudioCodec

public CallCenter.GroupCallCenterAddInstanceRequest setExternalPreferredAudioCodec(AudioFileCodec22 externalPreferredAudioCodec)

getExternalPreferredAudioCodec

public AudioFileCodec22 getExternalPreferredAudioCodec()

setInternalPreferredAudioCodec

public CallCenter.GroupCallCenterAddInstanceRequest setInternalPreferredAudioCodec(AudioFileCodec22 internalPreferredAudioCodec)

getInternalPreferredAudioCodec

public AudioFileCodec22 getInternalPreferredAudioCodec()

setPlayRingingWhenOfferingCall

public CallCenter.GroupCallCenterAddInstanceRequest setPlayRingingWhenOfferingCall(Boolean playRingingWhenOfferingCall)

getPlayRingingWhenOfferingCall

public Boolean getPlayRingingWhenOfferingCall()

setNetworkClassOfService

public CallCenter.GroupCallCenterAddInstanceRequest setNetworkClassOfService(String networkClassOfService)

getNetworkClassOfService

public String getNetworkClassOfService()

getEmptyObject

public static CallCenter.GroupCallCenterAddInstanceRequest 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>