Package co.ecg.alpaca.toolkit.generated

Class RoutePoint.GroupRoutePointModifyInstanceRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.RoutePoint.GroupRoutePointModifyInstanceRequest

Enclosing class:

RoutePoint

public static class RoutePoint.GroupRoutePointModifyInstanceRequest
extends Request<DefaultResponse>

Request to modify a Route Point instance. 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 AgentACDAutomaticState	agentStateAfterCall
protected Optional<@Size(min=1,max=10) String>	agentUnavailableCode
protected Integer	callAdmissionTimerSeconds
protected Boolean	enableAutomaticStateChangeForAgents
protected Boolean	enableUnlimitedQueueLength
protected Boolean	enableVideo
protected AudioFileCodec22	externalPreferredAudioCodec
protected Boolean	forceDeliveryOfCalls
protected Optional<Integer>	forceDeliveryWaitTimeSeconds
protected AudioFileCodec22	internalPreferredAudioCodec
protected @Size(min=1,max=40) String	networkClassOfService
protected Integer	noAnswerTimeoutRings
protected Boolean	overrideAgentWrapUpTime
protected Boolean	playRingingWhenOfferingCall
protected Integer	queueLength
protected Boolean	sendCallAdmissionNotification
protected @Valid ServiceInstanceModifyProfile	serviceInstanceProfile
protected @NotNull @Valid RoutePoint	user
protected Optional<Integer>	wrapUpSeconds

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

log

Constructor Summary

Constructors

Constructor	Description
GroupRoutePointModifyInstanceRequest()
GroupRoutePointModifyInstanceRequest(RoutePoint user)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
AgentACDAutomaticState	getAgentStateAfterCall()
Optional<@Size(min=1,max=10) String>	getAgentUnavailableCode()
Integer	getCallAdmissionTimerSeconds()
static RoutePoint.GroupRoutePointModifyInstanceRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
Boolean	getEnableAutomaticStateChangeForAgents()
Boolean	getEnableUnlimitedQueueLength()
Boolean	getEnableVideo()
AudioFileCodec22	getExternalPreferredAudioCodec()
Boolean	getForceDeliveryOfCalls()
Optional<Integer>	getForceDeliveryWaitTimeSeconds()
AudioFileCodec22	getInternalPreferredAudioCodec()
String	getNetworkClassOfService()
Integer	getNoAnswerTimeoutRings()
Boolean	getOverrideAgentWrapUpTime()
Boolean	getPlayRingingWhenOfferingCall()
Integer	getQueueLength()
RoutePoint	getRoutePoint()
Boolean	getSendCallAdmissionNotification()
ServiceInstanceModifyProfile	getServiceInstanceProfile()
Optional<Integer>	getWrapUpSeconds()
RoutePoint.GroupRoutePointModifyInstanceRequest	setAgentStateAfterCall(AgentACDAutomaticState agentStateAfterCall)
RoutePoint.GroupRoutePointModifyInstanceRequest	setAgentUnavailableCode(String agentUnavailableCode)
RoutePoint.GroupRoutePointModifyInstanceRequest	setCallAdmissionTimerSeconds(Integer callAdmissionTimerSeconds)
RoutePoint.GroupRoutePointModifyInstanceRequest	setEnableAutomaticStateChangeForAgents(Boolean enableAutomaticStateChangeForAgents)
RoutePoint.GroupRoutePointModifyInstanceRequest	setEnableUnlimitedQueueLength(Boolean enableUnlimitedQueueLength)
RoutePoint.GroupRoutePointModifyInstanceRequest	setEnableVideo(Boolean enableVideo)
RoutePoint.GroupRoutePointModifyInstanceRequest	setExternalPreferredAudioCodec(AudioFileCodec22 externalPreferredAudioCodec)
RoutePoint.GroupRoutePointModifyInstanceRequest	setForceDeliveryOfCalls(Boolean forceDeliveryOfCalls)
RoutePoint.GroupRoutePointModifyInstanceRequest	setForceDeliveryWaitTimeSeconds(Integer forceDeliveryWaitTimeSeconds)
RoutePoint.GroupRoutePointModifyInstanceRequest	setInternalPreferredAudioCodec(AudioFileCodec22 internalPreferredAudioCodec)
RoutePoint.GroupRoutePointModifyInstanceRequest	setNetworkClassOfService(String networkClassOfService)
RoutePoint.GroupRoutePointModifyInstanceRequest	setNoAnswerTimeoutRings(Integer noAnswerTimeoutRings)
RoutePoint.GroupRoutePointModifyInstanceRequest	setOverrideAgentWrapUpTime(Boolean overrideAgentWrapUpTime)
RoutePoint.GroupRoutePointModifyInstanceRequest	setPlayRingingWhenOfferingCall(Boolean playRingingWhenOfferingCall)
RoutePoint.GroupRoutePointModifyInstanceRequest	setQueueLength(Integer queueLength)
RoutePoint.GroupRoutePointModifyInstanceRequest	setSendCallAdmissionNotification(Boolean sendCallAdmissionNotification)
RoutePoint.GroupRoutePointModifyInstanceRequest	setServiceInstanceProfile(ServiceInstanceModifyProfile serviceInstanceProfile)
RoutePoint.GroupRoutePointModifyInstanceRequest	setUser(RoutePoint user)
RoutePoint.GroupRoutePointModifyInstanceRequest	setWrapUpSeconds(Integer wrapUpSeconds)
RoutePoint.GroupRoutePointModifyInstanceRequest	unsetAgentUnavailableCode()
RoutePoint.GroupRoutePointModifyInstanceRequest	unsetForceDeliveryWaitTimeSeconds()
RoutePoint.GroupRoutePointModifyInstanceRequest	unsetWrapUpSeconds()

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 Detail

user

@NotNull
@Valid
protected transient @NotNull @Valid RoutePoint user

serviceInstanceProfile

@Valid
protected @Valid ServiceInstanceModifyProfile serviceInstanceProfile

networkClassOfService

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

externalPreferredAudioCodec

protected AudioFileCodec22 externalPreferredAudioCodec

internalPreferredAudioCodec

protected AudioFileCodec22 internalPreferredAudioCodec

queueLength

protected Integer queueLength

noAnswerTimeoutRings

protected Integer noAnswerTimeoutRings

enableVideo

protected Boolean enableVideo

playRingingWhenOfferingCall

protected Boolean playRingingWhenOfferingCall

overrideAgentWrapUpTime

protected Boolean overrideAgentWrapUpTime

wrapUpSeconds

protected Optional<Integer> wrapUpSeconds

enableAutomaticStateChangeForAgents

protected Boolean enableAutomaticStateChangeForAgents

agentStateAfterCall

protected AgentACDAutomaticState agentStateAfterCall

agentUnavailableCode

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

forceDeliveryOfCalls

protected Boolean forceDeliveryOfCalls

forceDeliveryWaitTimeSeconds

protected Optional<Integer> forceDeliveryWaitTimeSeconds

sendCallAdmissionNotification

protected Boolean sendCallAdmissionNotification

callAdmissionTimerSeconds

protected Integer callAdmissionTimerSeconds

enableUnlimitedQueueLength

protected Boolean enableUnlimitedQueueLength

Constructor Detail

GroupRoutePointModifyInstanceRequest

public GroupRoutePointModifyInstanceRequest()

GroupRoutePointModifyInstanceRequest

public GroupRoutePointModifyInstanceRequest(RoutePoint user)

Method Detail

setUser

public RoutePoint.GroupRoutePointModifyInstanceRequest setUser(RoutePoint user)

getRoutePoint

public RoutePoint getRoutePoint()

setServiceInstanceProfile

public RoutePoint.GroupRoutePointModifyInstanceRequest setServiceInstanceProfile(ServiceInstanceModifyProfile serviceInstanceProfile)

getServiceInstanceProfile

public ServiceInstanceModifyProfile getServiceInstanceProfile()

setNetworkClassOfService

public RoutePoint.GroupRoutePointModifyInstanceRequest setNetworkClassOfService(String networkClassOfService)

getNetworkClassOfService

public String getNetworkClassOfService()

setExternalPreferredAudioCodec

public RoutePoint.GroupRoutePointModifyInstanceRequest setExternalPreferredAudioCodec(AudioFileCodec22 externalPreferredAudioCodec)

getExternalPreferredAudioCodec

public AudioFileCodec22 getExternalPreferredAudioCodec()

setInternalPreferredAudioCodec

public RoutePoint.GroupRoutePointModifyInstanceRequest setInternalPreferredAudioCodec(AudioFileCodec22 internalPreferredAudioCodec)

getInternalPreferredAudioCodec

public AudioFileCodec22 getInternalPreferredAudioCodec()

setQueueLength

public RoutePoint.GroupRoutePointModifyInstanceRequest setQueueLength(Integer queueLength)

getQueueLength

public Integer getQueueLength()

setNoAnswerTimeoutRings

public RoutePoint.GroupRoutePointModifyInstanceRequest setNoAnswerTimeoutRings(Integer noAnswerTimeoutRings)

getNoAnswerTimeoutRings

public Integer getNoAnswerTimeoutRings()

setEnableVideo

public RoutePoint.GroupRoutePointModifyInstanceRequest setEnableVideo(Boolean enableVideo)

getEnableVideo

public Boolean getEnableVideo()

setPlayRingingWhenOfferingCall

public RoutePoint.GroupRoutePointModifyInstanceRequest setPlayRingingWhenOfferingCall(Boolean playRingingWhenOfferingCall)

getPlayRingingWhenOfferingCall

public Boolean getPlayRingingWhenOfferingCall()

setOverrideAgentWrapUpTime

public RoutePoint.GroupRoutePointModifyInstanceRequest setOverrideAgentWrapUpTime(Boolean overrideAgentWrapUpTime)

getOverrideAgentWrapUpTime

public Boolean getOverrideAgentWrapUpTime()

unsetWrapUpSeconds

public RoutePoint.GroupRoutePointModifyInstanceRequest unsetWrapUpSeconds()

setWrapUpSeconds

public RoutePoint.GroupRoutePointModifyInstanceRequest setWrapUpSeconds(Integer wrapUpSeconds)

getWrapUpSeconds

public Optional<Integer> getWrapUpSeconds()

setEnableAutomaticStateChangeForAgents

public RoutePoint.GroupRoutePointModifyInstanceRequest setEnableAutomaticStateChangeForAgents(Boolean enableAutomaticStateChangeForAgents)

getEnableAutomaticStateChangeForAgents

public Boolean getEnableAutomaticStateChangeForAgents()

setAgentStateAfterCall

public RoutePoint.GroupRoutePointModifyInstanceRequest setAgentStateAfterCall(AgentACDAutomaticState agentStateAfterCall)

getAgentStateAfterCall

public AgentACDAutomaticState getAgentStateAfterCall()

unsetAgentUnavailableCode

public RoutePoint.GroupRoutePointModifyInstanceRequest unsetAgentUnavailableCode()

setAgentUnavailableCode

public RoutePoint.GroupRoutePointModifyInstanceRequest setAgentUnavailableCode(String agentUnavailableCode)

getAgentUnavailableCode

public Optional<@Size(min=1,max=10) String> getAgentUnavailableCode()

setForceDeliveryOfCalls

public RoutePoint.GroupRoutePointModifyInstanceRequest setForceDeliveryOfCalls(Boolean forceDeliveryOfCalls)

getForceDeliveryOfCalls

public Boolean getForceDeliveryOfCalls()

unsetForceDeliveryWaitTimeSeconds

public RoutePoint.GroupRoutePointModifyInstanceRequest unsetForceDeliveryWaitTimeSeconds()

setForceDeliveryWaitTimeSeconds

public RoutePoint.GroupRoutePointModifyInstanceRequest setForceDeliveryWaitTimeSeconds(Integer forceDeliveryWaitTimeSeconds)

getForceDeliveryWaitTimeSeconds

public Optional<Integer> getForceDeliveryWaitTimeSeconds()

setSendCallAdmissionNotification

public RoutePoint.GroupRoutePointModifyInstanceRequest setSendCallAdmissionNotification(Boolean sendCallAdmissionNotification)

getSendCallAdmissionNotification

public Boolean getSendCallAdmissionNotification()

setCallAdmissionTimerSeconds

public RoutePoint.GroupRoutePointModifyInstanceRequest setCallAdmissionTimerSeconds(Integer callAdmissionTimerSeconds)

getCallAdmissionTimerSeconds

public Integer getCallAdmissionTimerSeconds()

setEnableUnlimitedQueueLength

public RoutePoint.GroupRoutePointModifyInstanceRequest setEnableUnlimitedQueueLength(Boolean enableUnlimitedQueueLength)

getEnableUnlimitedQueueLength

public Boolean getEnableUnlimitedQueueLength()

getEmptyObject

public static RoutePoint.GroupRoutePointModifyInstanceRequest 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>