Package co.ecg.alpaca.toolkit.generated

Class CallCenter.UserCallCenterModifyRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.CallCenter.UserCallCenterModifyRequest

Enclosing class:

CallCenter

public static class CallCenter.UserCallCenterModifyRequest
extends Request<DefaultResponse>

Modifies the agents call center settings and the availability for an agent in one or more Call Centers. Contains a list specifying the desired availability status of one or more call centers. A default unavailable code will be used if the parameter agentUnavailableCode is not active, included or is invalid. Changing the agentACDState from unavailable to any other state will automatically clear the unavailable code. The response is either a SuccessResponse or an ErrorResponse. The following elements are only used in AS data mode and ignored in XS data mode: agentACDState agentThresholdProfileName agentUnavailableCode useSystemDefaultUnavailableSettings forceAgentUnavailableOnDNDActivation forceAgentUnavailableOnPersonalCalls forceAgentUnavailableOnBouncedCallLimit numberConsecutiveBouncedCallsToForceAgentUnavailable forceAgentUnavailableOnNotReachable makeOutgoingCallsAsCallCenter outgoingCallDNIS useSystemDefaultWrapUpDestination wrapUpDestination

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 AgentACDState	agentACDState
protected @Size(min=1,max=40) String	agentThresholdProfileName
protected Optional<@Size(min=1,max=10) String>	agentUnavailableCode
protected @Valid CallCenterAgentSettings[]	callCenterAgentSettings
protected Boolean	enableGuardTimer
protected Boolean	forceAgentUnavailableOnBouncedCallLimit
protected Boolean	forceAgentUnavailableOnDNDActivation
protected Boolean	forceAgentUnavailableOnNotReachable
protected Boolean	forceAgentUnavailableOnPersonalCalls
protected Integer	guardTimerSeconds
protected Boolean	makeOutgoingCallsAsCallCenter
protected Integer	numberConsecutiveBouncedCallsToForceAgentUnavailable
protected Optional<@Valid DNISKey>	outgoingCallDNIS
protected Boolean	useDefaultGuardTimer
protected @NotNull @Valid BroadWorksUser	user
protected Boolean	useSystemDefaultUnavailableSettings
protected Boolean	useSystemDefaultWrapUpDestination
protected Optional<@Size(min=1,max=161) String>	wrapUpDestination

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

log

Constructor Summary

Constructors

Constructor	Description
UserCallCenterModifyRequest()
UserCallCenterModifyRequest(BroadWorksUser user)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
AgentACDState	getAgentACDState()
String	getAgentThresholdProfileName()
Optional<@Size(min=1,max=10) String>	getAgentUnavailableCode()
BroadWorksUser	getBroadWorksUser()
CallCenterAgentSettings[]	getCallCenterAgentSettings()
static CallCenter.UserCallCenterModifyRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
Boolean	getEnableGuardTimer()
Boolean	getForceAgentUnavailableOnBouncedCallLimit()
Boolean	getForceAgentUnavailableOnDNDActivation()
Boolean	getForceAgentUnavailableOnNotReachable()
Boolean	getForceAgentUnavailableOnPersonalCalls()
Integer	getGuardTimerSeconds()
Boolean	getMakeOutgoingCallsAsCallCenter()
Integer	getNumberConsecutiveBouncedCallsToForceAgentUnavailable()
Optional<@Valid DNISKey>	getOutgoingCallDNIS()
Boolean	getUseDefaultGuardTimer()
Boolean	getUseSystemDefaultUnavailableSettings()
Boolean	getUseSystemDefaultWrapUpDestination()
Optional<@Size(min=1,max=161) String>	getWrapUpDestination()
CallCenter.UserCallCenterModifyRequest	setAgentACDState(AgentACDState agentACDState)
CallCenter.UserCallCenterModifyRequest	setAgentThresholdProfileName(String agentThresholdProfileName)
CallCenter.UserCallCenterModifyRequest	setAgentUnavailableCode(String agentUnavailableCode)
CallCenter.UserCallCenterModifyRequest	setCallCenterAgentSettings(CallCenterAgentSettings... callCenterAgentSettings)
CallCenter.UserCallCenterModifyRequest	setEnableGuardTimer(Boolean enableGuardTimer)
CallCenter.UserCallCenterModifyRequest	setForceAgentUnavailableOnBouncedCallLimit(Boolean forceAgentUnavailableOnBouncedCallLimit)
CallCenter.UserCallCenterModifyRequest	setForceAgentUnavailableOnDNDActivation(Boolean forceAgentUnavailableOnDNDActivation)
CallCenter.UserCallCenterModifyRequest	setForceAgentUnavailableOnNotReachable(Boolean forceAgentUnavailableOnNotReachable)
CallCenter.UserCallCenterModifyRequest	setForceAgentUnavailableOnPersonalCalls(Boolean forceAgentUnavailableOnPersonalCalls)
CallCenter.UserCallCenterModifyRequest	setGuardTimerSeconds(Integer guardTimerSeconds)
CallCenter.UserCallCenterModifyRequest	setMakeOutgoingCallsAsCallCenter(Boolean makeOutgoingCallsAsCallCenter)
CallCenter.UserCallCenterModifyRequest	setNumberConsecutiveBouncedCallsToForceAgentUnavailable(Integer numberConsecutiveBouncedCallsToForceAgentUnavailable)
CallCenter.UserCallCenterModifyRequest	setOutgoingCallDNIS(DNISKey outgoingCallDNIS)
CallCenter.UserCallCenterModifyRequest	setUseDefaultGuardTimer(Boolean useDefaultGuardTimer)
CallCenter.UserCallCenterModifyRequest	setUser(BroadWorksUser user)
CallCenter.UserCallCenterModifyRequest	setUseSystemDefaultUnavailableSettings(Boolean useSystemDefaultUnavailableSettings)
CallCenter.UserCallCenterModifyRequest	setUseSystemDefaultWrapUpDestination(Boolean useSystemDefaultWrapUpDestination)
CallCenter.UserCallCenterModifyRequest	setWrapUpDestination(String wrapUpDestination)
CallCenter.UserCallCenterModifyRequest	unsetAgentUnavailableCode()
CallCenter.UserCallCenterModifyRequest	unsetOutgoingCallDNIS()
CallCenter.UserCallCenterModifyRequest	unsetWrapUpDestination()

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

user

@NotNull
@Valid
protected transient @NotNull @Valid BroadWorksUser user

agentACDState

protected AgentACDState agentACDState

agentThresholdProfileName

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

agentUnavailableCode

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

useDefaultGuardTimer

protected Boolean useDefaultGuardTimer

enableGuardTimer

protected Boolean enableGuardTimer

guardTimerSeconds

protected Integer guardTimerSeconds

useSystemDefaultUnavailableSettings

protected Boolean useSystemDefaultUnavailableSettings

forceAgentUnavailableOnDNDActivation

protected Boolean forceAgentUnavailableOnDNDActivation

forceAgentUnavailableOnPersonalCalls

protected Boolean forceAgentUnavailableOnPersonalCalls

forceAgentUnavailableOnBouncedCallLimit

protected Boolean forceAgentUnavailableOnBouncedCallLimit

numberConsecutiveBouncedCallsToForceAgentUnavailable

protected Integer numberConsecutiveBouncedCallsToForceAgentUnavailable

forceAgentUnavailableOnNotReachable

protected Boolean forceAgentUnavailableOnNotReachable

makeOutgoingCallsAsCallCenter

protected Boolean makeOutgoingCallsAsCallCenter

outgoingCallDNIS

protected Optional<@Valid DNISKey> outgoingCallDNIS

callCenterAgentSettings

@Valid
protected @Valid CallCenterAgentSettings[] callCenterAgentSettings

useSystemDefaultWrapUpDestination

protected Boolean useSystemDefaultWrapUpDestination

wrapUpDestination

protected Optional<@Size(min=1,max=161) String> wrapUpDestination

Constructor Details

UserCallCenterModifyRequest

public UserCallCenterModifyRequest()

UserCallCenterModifyRequest

public UserCallCenterModifyRequest(BroadWorksUser user)

Method Details

setUser

public CallCenter.UserCallCenterModifyRequest setUser(BroadWorksUser user)

getBroadWorksUser

public BroadWorksUser getBroadWorksUser()

setAgentACDState

public CallCenter.UserCallCenterModifyRequest setAgentACDState(AgentACDState agentACDState)

getAgentACDState

public AgentACDState getAgentACDState()

setAgentThresholdProfileName

public CallCenter.UserCallCenterModifyRequest setAgentThresholdProfileName(String agentThresholdProfileName)

getAgentThresholdProfileName

public String getAgentThresholdProfileName()

unsetAgentUnavailableCode

public CallCenter.UserCallCenterModifyRequest unsetAgentUnavailableCode()

setAgentUnavailableCode

public CallCenter.UserCallCenterModifyRequest setAgentUnavailableCode(String agentUnavailableCode)

getAgentUnavailableCode

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

setUseDefaultGuardTimer

public CallCenter.UserCallCenterModifyRequest setUseDefaultGuardTimer(Boolean useDefaultGuardTimer)

getUseDefaultGuardTimer

public Boolean getUseDefaultGuardTimer()

setEnableGuardTimer

public CallCenter.UserCallCenterModifyRequest setEnableGuardTimer(Boolean enableGuardTimer)

getEnableGuardTimer

public Boolean getEnableGuardTimer()

setGuardTimerSeconds

public CallCenter.UserCallCenterModifyRequest setGuardTimerSeconds(Integer guardTimerSeconds)

getGuardTimerSeconds

public Integer getGuardTimerSeconds()

setUseSystemDefaultUnavailableSettings

public CallCenter.UserCallCenterModifyRequest setUseSystemDefaultUnavailableSettings(Boolean useSystemDefaultUnavailableSettings)

getUseSystemDefaultUnavailableSettings

public Boolean getUseSystemDefaultUnavailableSettings()

setForceAgentUnavailableOnDNDActivation

public CallCenter.UserCallCenterModifyRequest setForceAgentUnavailableOnDNDActivation(Boolean forceAgentUnavailableOnDNDActivation)

getForceAgentUnavailableOnDNDActivation

public Boolean getForceAgentUnavailableOnDNDActivation()

setForceAgentUnavailableOnPersonalCalls

public CallCenter.UserCallCenterModifyRequest setForceAgentUnavailableOnPersonalCalls(Boolean forceAgentUnavailableOnPersonalCalls)

getForceAgentUnavailableOnPersonalCalls

public Boolean getForceAgentUnavailableOnPersonalCalls()

setForceAgentUnavailableOnBouncedCallLimit

public CallCenter.UserCallCenterModifyRequest setForceAgentUnavailableOnBouncedCallLimit(Boolean forceAgentUnavailableOnBouncedCallLimit)

getForceAgentUnavailableOnBouncedCallLimit

public Boolean getForceAgentUnavailableOnBouncedCallLimit()

setNumberConsecutiveBouncedCallsToForceAgentUnavailable

public CallCenter.UserCallCenterModifyRequest setNumberConsecutiveBouncedCallsToForceAgentUnavailable(Integer numberConsecutiveBouncedCallsToForceAgentUnavailable)

getNumberConsecutiveBouncedCallsToForceAgentUnavailable

public Integer getNumberConsecutiveBouncedCallsToForceAgentUnavailable()

setForceAgentUnavailableOnNotReachable

public CallCenter.UserCallCenterModifyRequest setForceAgentUnavailableOnNotReachable(Boolean forceAgentUnavailableOnNotReachable)

getForceAgentUnavailableOnNotReachable

public Boolean getForceAgentUnavailableOnNotReachable()

setMakeOutgoingCallsAsCallCenter

public CallCenter.UserCallCenterModifyRequest setMakeOutgoingCallsAsCallCenter(Boolean makeOutgoingCallsAsCallCenter)

getMakeOutgoingCallsAsCallCenter

public Boolean getMakeOutgoingCallsAsCallCenter()

unsetOutgoingCallDNIS

public CallCenter.UserCallCenterModifyRequest unsetOutgoingCallDNIS()

setOutgoingCallDNIS

public CallCenter.UserCallCenterModifyRequest setOutgoingCallDNIS(DNISKey outgoingCallDNIS)

getOutgoingCallDNIS

public Optional<@Valid DNISKey> getOutgoingCallDNIS()

setCallCenterAgentSettings

public CallCenter.UserCallCenterModifyRequest setCallCenterAgentSettings(CallCenterAgentSettings... callCenterAgentSettings)

getCallCenterAgentSettings

public CallCenterAgentSettings[] getCallCenterAgentSettings()

setUseSystemDefaultWrapUpDestination

public CallCenter.UserCallCenterModifyRequest setUseSystemDefaultWrapUpDestination(Boolean useSystemDefaultWrapUpDestination)

getUseSystemDefaultWrapUpDestination

public Boolean getUseSystemDefaultWrapUpDestination()

unsetWrapUpDestination

public CallCenter.UserCallCenterModifyRequest unsetWrapUpDestination()

setWrapUpDestination

public CallCenter.UserCallCenterModifyRequest setWrapUpDestination(String wrapUpDestination)

getWrapUpDestination

public Optional<@Size(min=1,max=161) String> getWrapUpDestination()

getEmptyObject

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