co.ecg.alpaca.toolkit.generated.services

Class CallCenter.UserCallCenterModifyRequest19

java.lang.Object

co.ecg.alpaca.toolkit.Request<Response.DefaultResponse>

co.ecg.alpaca.toolkit.generated.services.CallCenter.UserCallCenterModifyRequest19

All Implemented Interfaces:

Runnable

Enclosing class:

CallCenter

public static class CallCenter.UserCallCenterModifyRequest19
extends Request<Response.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.

Field Summary

Fields

Modifier and Type	Field and Description
AgentACDState	agentACDState
boolean	agentACDStateIsModified
String	agentThresholdProfileName
boolean	agentThresholdProfileNameIsModified
String	agentUnavailableCode
boolean	agentUnavailableCodeIsModified
CallCenterAgentSettings[]	callCenterAgentSettings
boolean	callCenterAgentSettingsIsModified
Boolean	enableGuardTimer
boolean	enableGuardTimerIsModified
Boolean	forceAgentUnavailableOnBouncedCallLimit
boolean	forceAgentUnavailableOnBouncedCallLimitIsModified
Boolean	forceAgentUnavailableOnDNDActivation
boolean	forceAgentUnavailableOnDNDActivationIsModified
Boolean	forceAgentUnavailableOnNotReachable
boolean	forceAgentUnavailableOnNotReachableIsModified
Boolean	forceAgentUnavailableOnPersonalCalls
boolean	forceAgentUnavailableOnPersonalCallsIsModified
Integer	guardTimerSeconds
boolean	guardTimerSecondsIsModified
Boolean	makeOutgoingCallsAsCallCenter
boolean	makeOutgoingCallsAsCallCenterIsModified
Integer	numberConsecutiveBouncedCallsToForceAgentUnavailable
boolean	numberConsecutiveBouncedCallsToForceAgentUnavailableIsModified
DNISKey	outgoingCallDNIS
boolean	outgoingCallDNISIsModified
Boolean	useDefaultGuardTimer
boolean	useDefaultGuardTimerIsModified
User	user
boolean	userIsModified
Boolean	useSystemDefaultUnavailableSettings
boolean	useSystemDefaultUnavailableSettingsIsModified

Constructor Summary

Constructors

Constructor and Description
UserCallCenterModifyRequest19(BroadWorksServer bws) Default Constructor -- Not Guaranteed to work without checking Request validity with isValid()
UserCallCenterModifyRequest19(User user)

Method Summary

Modifier and Type	Method and Description
void	formRequest() Forms the XML Document for this Request Object.
AgentACDState	getAgentACDState()
String	getAgentThresholdProfileName()
String	getAgentUnavailableCode()
CallCenterAgentSettings[]	getCallCenterAgentSettings()
Boolean	getEnableGuardTimer()
Boolean	getForceAgentUnavailableOnBouncedCallLimit()
Boolean	getForceAgentUnavailableOnDNDActivation()
Boolean	getForceAgentUnavailableOnNotReachable()
Boolean	getForceAgentUnavailableOnPersonalCalls()
Integer	getGuardTimerSeconds()
Boolean	getMakeOutgoingCallsAsCallCenter()
Integer	getNumberConsecutiveBouncedCallsToForceAgentUnavailable()
DNISKey	getOutgoingCallDNIS()
Boolean	getUseDefaultGuardTimer()
User	getUser()
Boolean	getUseSystemDefaultUnavailableSettings()
CallCenter.UserCallCenterModifyRequest19	setAgentACDState(AgentACDState agentACDState)
CallCenter.UserCallCenterModifyRequest19	setAgentThresholdProfileName(String agentThresholdProfileName)
CallCenter.UserCallCenterModifyRequest19	setAgentUnavailableCode(String agentUnavailableCode)
CallCenter.UserCallCenterModifyRequest19	setCallCenterAgentSettings(CallCenterAgentSettings... callCenterAgentSettings)
CallCenter.UserCallCenterModifyRequest19	setEnableGuardTimer(Boolean enableGuardTimer)
CallCenter.UserCallCenterModifyRequest19	setForceAgentUnavailableOnBouncedCallLimit(Boolean forceAgentUnavailableOnBouncedCallLimit)
CallCenter.UserCallCenterModifyRequest19	setForceAgentUnavailableOnDNDActivation(Boolean forceAgentUnavailableOnDNDActivation)
CallCenter.UserCallCenterModifyRequest19	setForceAgentUnavailableOnNotReachable(Boolean forceAgentUnavailableOnNotReachable)
CallCenter.UserCallCenterModifyRequest19	setForceAgentUnavailableOnPersonalCalls(Boolean forceAgentUnavailableOnPersonalCalls)
CallCenter.UserCallCenterModifyRequest19	setGuardTimerSeconds(Integer guardTimerSeconds)
CallCenter.UserCallCenterModifyRequest19	setMakeOutgoingCallsAsCallCenter(Boolean makeOutgoingCallsAsCallCenter)
CallCenter.UserCallCenterModifyRequest19	setNumberConsecutiveBouncedCallsToForceAgentUnavailable(Integer numberConsecutiveBouncedCallsToForceAgentUnavailable)
CallCenter.UserCallCenterModifyRequest19	setOutgoingCallDNIS(DNISKey outgoingCallDNIS)
CallCenter.UserCallCenterModifyRequest19	setUseDefaultGuardTimer(Boolean useDefaultGuardTimer)
CallCenter.UserCallCenterModifyRequest19	setUser(User user)
CallCenter.UserCallCenterModifyRequest19	setUseSystemDefaultUnavailableSettings(Boolean useSystemDefaultUnavailableSettings)

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

appendChild, appendChild, appendChild, asyncFire, createElement, createNilElement, createTextElement, fire, fire, getBroadWorksServer, getCommandType, getDomDocument, getResponseClass, isMemberOfBundle, isValid, run, setBroadWorksServer, setCommandElement, setCommandType, setDomDocument, setMemberOfBundle, setRequestId, setResponseClass, setRootElement, toString, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

user

@NotNull
public User user

userIsModified

public transient boolean userIsModified

agentACDState

public AgentACDState agentACDState

agentACDStateIsModified

public transient boolean agentACDStateIsModified

agentThresholdProfileName

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

agentThresholdProfileNameIsModified

public transient boolean agentThresholdProfileNameIsModified

agentUnavailableCode

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

agentUnavailableCodeIsModified

public transient boolean agentUnavailableCodeIsModified

useDefaultGuardTimer

public Boolean useDefaultGuardTimer

useDefaultGuardTimerIsModified

public transient boolean useDefaultGuardTimerIsModified

enableGuardTimer

public Boolean enableGuardTimer

enableGuardTimerIsModified

public transient boolean enableGuardTimerIsModified

guardTimerSeconds

public Integer guardTimerSeconds

guardTimerSecondsIsModified

public transient boolean guardTimerSecondsIsModified

useSystemDefaultUnavailableSettings

public Boolean useSystemDefaultUnavailableSettings

useSystemDefaultUnavailableSettingsIsModified

public transient boolean useSystemDefaultUnavailableSettingsIsModified

forceAgentUnavailableOnDNDActivation

public Boolean forceAgentUnavailableOnDNDActivation

forceAgentUnavailableOnDNDActivationIsModified

public transient boolean forceAgentUnavailableOnDNDActivationIsModified

forceAgentUnavailableOnPersonalCalls

public Boolean forceAgentUnavailableOnPersonalCalls

forceAgentUnavailableOnPersonalCallsIsModified

public transient boolean forceAgentUnavailableOnPersonalCallsIsModified

forceAgentUnavailableOnBouncedCallLimit

public Boolean forceAgentUnavailableOnBouncedCallLimit

forceAgentUnavailableOnBouncedCallLimitIsModified

public transient boolean forceAgentUnavailableOnBouncedCallLimitIsModified

numberConsecutiveBouncedCallsToForceAgentUnavailable

public Integer numberConsecutiveBouncedCallsToForceAgentUnavailable

numberConsecutiveBouncedCallsToForceAgentUnavailableIsModified

public transient boolean numberConsecutiveBouncedCallsToForceAgentUnavailableIsModified

forceAgentUnavailableOnNotReachable

public Boolean forceAgentUnavailableOnNotReachable

forceAgentUnavailableOnNotReachableIsModified

public transient boolean forceAgentUnavailableOnNotReachableIsModified

makeOutgoingCallsAsCallCenter

public Boolean makeOutgoingCallsAsCallCenter

makeOutgoingCallsAsCallCenterIsModified

public transient boolean makeOutgoingCallsAsCallCenterIsModified

outgoingCallDNIS

public DNISKey outgoingCallDNIS

outgoingCallDNISIsModified

public transient boolean outgoingCallDNISIsModified

callCenterAgentSettings

public CallCenterAgentSettings[] callCenterAgentSettings

callCenterAgentSettingsIsModified

public transient boolean callCenterAgentSettingsIsModified

Constructor Detail

UserCallCenterModifyRequest19

public UserCallCenterModifyRequest19(User user)

UserCallCenterModifyRequest19

public UserCallCenterModifyRequest19(BroadWorksServer bws)

Default Constructor -- Not Guaranteed to work without checking Request validity with isValid()

Parameters:

bws - The BroadWorksServer to use for the Request

Method Detail

setUser

public CallCenter.UserCallCenterModifyRequest19 setUser(User user)

getUser

public User getUser()

setAgentACDState

public CallCenter.UserCallCenterModifyRequest19 setAgentACDState(AgentACDState agentACDState)

getAgentACDState

public AgentACDState getAgentACDState()

setAgentThresholdProfileName

public CallCenter.UserCallCenterModifyRequest19 setAgentThresholdProfileName(String agentThresholdProfileName)

getAgentThresholdProfileName

public String getAgentThresholdProfileName()

setAgentUnavailableCode

public CallCenter.UserCallCenterModifyRequest19 setAgentUnavailableCode(String agentUnavailableCode)

getAgentUnavailableCode

public String getAgentUnavailableCode()

setUseDefaultGuardTimer

public CallCenter.UserCallCenterModifyRequest19 setUseDefaultGuardTimer(Boolean useDefaultGuardTimer)

getUseDefaultGuardTimer

public Boolean getUseDefaultGuardTimer()

setEnableGuardTimer

public CallCenter.UserCallCenterModifyRequest19 setEnableGuardTimer(Boolean enableGuardTimer)

getEnableGuardTimer

public Boolean getEnableGuardTimer()

setGuardTimerSeconds

public CallCenter.UserCallCenterModifyRequest19 setGuardTimerSeconds(Integer guardTimerSeconds)

getGuardTimerSeconds

public Integer getGuardTimerSeconds()

setUseSystemDefaultUnavailableSettings

public CallCenter.UserCallCenterModifyRequest19 setUseSystemDefaultUnavailableSettings(Boolean useSystemDefaultUnavailableSettings)

getUseSystemDefaultUnavailableSettings

public Boolean getUseSystemDefaultUnavailableSettings()

setForceAgentUnavailableOnDNDActivation

public CallCenter.UserCallCenterModifyRequest19 setForceAgentUnavailableOnDNDActivation(Boolean forceAgentUnavailableOnDNDActivation)

getForceAgentUnavailableOnDNDActivation

public Boolean getForceAgentUnavailableOnDNDActivation()

setForceAgentUnavailableOnPersonalCalls

public CallCenter.UserCallCenterModifyRequest19 setForceAgentUnavailableOnPersonalCalls(Boolean forceAgentUnavailableOnPersonalCalls)

getForceAgentUnavailableOnPersonalCalls

public Boolean getForceAgentUnavailableOnPersonalCalls()

setForceAgentUnavailableOnBouncedCallLimit

public CallCenter.UserCallCenterModifyRequest19 setForceAgentUnavailableOnBouncedCallLimit(Boolean forceAgentUnavailableOnBouncedCallLimit)

getForceAgentUnavailableOnBouncedCallLimit

public Boolean getForceAgentUnavailableOnBouncedCallLimit()

setNumberConsecutiveBouncedCallsToForceAgentUnavailable

public CallCenter.UserCallCenterModifyRequest19 setNumberConsecutiveBouncedCallsToForceAgentUnavailable(Integer numberConsecutiveBouncedCallsToForceAgentUnavailable)

getNumberConsecutiveBouncedCallsToForceAgentUnavailable

public Integer getNumberConsecutiveBouncedCallsToForceAgentUnavailable()

setForceAgentUnavailableOnNotReachable

public CallCenter.UserCallCenterModifyRequest19 setForceAgentUnavailableOnNotReachable(Boolean forceAgentUnavailableOnNotReachable)

getForceAgentUnavailableOnNotReachable

public Boolean getForceAgentUnavailableOnNotReachable()

setMakeOutgoingCallsAsCallCenter

public CallCenter.UserCallCenterModifyRequest19 setMakeOutgoingCallsAsCallCenter(Boolean makeOutgoingCallsAsCallCenter)

getMakeOutgoingCallsAsCallCenter

public Boolean getMakeOutgoingCallsAsCallCenter()

setOutgoingCallDNIS

public CallCenter.UserCallCenterModifyRequest19 setOutgoingCallDNIS(DNISKey outgoingCallDNIS)

getOutgoingCallDNIS

public DNISKey getOutgoingCallDNIS()

setCallCenterAgentSettings

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

getCallCenterAgentSettings

public CallCenterAgentSettings[] getCallCenterAgentSettings()

formRequest

public void formRequest()
                 throws RequestException

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

Specified by:

formRequest in class Request<Response.DefaultResponse>

Throws:

RequestException