Package co.ecg.alpaca.toolkit.generated.services

Class UserExecutive.UserExecutiveModifyScreeningAlertingRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.services.UserExecutive.UserExecutiveModifyScreeningAlertingRequest

Enclosing class:

UserExecutive

public static class UserExecutive.UserExecutiveModifyScreeningAlertingRequest
extends Request<DefaultResponse>

Modify the screening and alerting setting of an executive. Both executive and the executive assistant can run this command. 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 Boolean	alertBroadWorksAnywhereLocations
protected Boolean	alertBroadWorksMobilityLocation
protected ExecutiveAlertingCallingLineIdNameMode	alertingCallingLineIdNameMode
protected ExecutiveAlertingCallingLineIdPhoneNumberMode	alertingCallingLineIdPhoneNumberMode
protected Optional<@Size(min=1,max=80) String>	alertingCustomCallingLineIdName
protected Optional<@Size(min=1,max=23) String>	alertingCustomCallingLineIdPhoneNumber
protected ExecutiveAlertingMode	alertingMode
protected Boolean	alertSharedCallAppearanceLocations
protected Integer	callPushRecallNumberOfRings
protected Boolean	enableRollover
protected Boolean	enableScreening
protected Integer	nextAssistantNumberOfRings
protected ExecutiveRolloverActionType	rolloverAction
protected Optional<@Size(min=1,max=161) String>	rolloverForwardToPhoneNumber
protected Optional<Integer>	rolloverWaitTimeSeconds
protected ExecutiveScreeningAlertType	screeningAlertType
protected Optional<@Size(min=1,max=80) String>	unicodeAlertingCustomCallingLineIdName
protected @NotNull @Valid BroadWorksUser	user

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

log

Constructor Summary

Constructors

Constructor	Description
UserExecutiveModifyScreeningAlertingRequest()
UserExecutiveModifyScreeningAlertingRequest(BroadWorksUser user)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
Boolean	getAlertBroadWorksAnywhereLocations()
Boolean	getAlertBroadWorksMobilityLocation()
ExecutiveAlertingCallingLineIdNameMode	getAlertingCallingLineIdNameMode()
ExecutiveAlertingCallingLineIdPhoneNumberMode	getAlertingCallingLineIdPhoneNumberMode()
Optional<@Size(min=1,max=80) String>	getAlertingCustomCallingLineIdName()
Optional<@Size(min=1,max=23) String>	getAlertingCustomCallingLineIdPhoneNumber()
ExecutiveAlertingMode	getAlertingMode()
Boolean	getAlertSharedCallAppearanceLocations()
BroadWorksUser	getBroadWorksUser()
Integer	getCallPushRecallNumberOfRings()
static UserExecutive.UserExecutiveModifyScreeningAlertingRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
Boolean	getEnableRollover()
Boolean	getEnableScreening()
Integer	getNextAssistantNumberOfRings()
ExecutiveRolloverActionType	getRolloverAction()
Optional<@Size(min=1,max=161) String>	getRolloverForwardToPhoneNumber()
Optional<Integer>	getRolloverWaitTimeSeconds()
ExecutiveScreeningAlertType	getScreeningAlertType()
Optional<@Size(min=1,max=80) String>	getUnicodeAlertingCustomCallingLineIdName()
UserExecutive.UserExecutiveModifyScreeningAlertingRequest	setAlertBroadWorksAnywhereLocations(Boolean alertBroadWorksAnywhereLocations)
UserExecutive.UserExecutiveModifyScreeningAlertingRequest	setAlertBroadWorksMobilityLocation(Boolean alertBroadWorksMobilityLocation)
UserExecutive.UserExecutiveModifyScreeningAlertingRequest	setAlertingCallingLineIdNameMode(ExecutiveAlertingCallingLineIdNameMode alertingCallingLineIdNameMode)
UserExecutive.UserExecutiveModifyScreeningAlertingRequest	setAlertingCallingLineIdPhoneNumberMode(ExecutiveAlertingCallingLineIdPhoneNumberMode alertingCallingLineIdPhoneNumberMode)
UserExecutive.UserExecutiveModifyScreeningAlertingRequest	setAlertingCustomCallingLineIdName(String alertingCustomCallingLineIdName)
UserExecutive.UserExecutiveModifyScreeningAlertingRequest	setAlertingCustomCallingLineIdPhoneNumber(String alertingCustomCallingLineIdPhoneNumber)
UserExecutive.UserExecutiveModifyScreeningAlertingRequest	setAlertingMode(ExecutiveAlertingMode alertingMode)
UserExecutive.UserExecutiveModifyScreeningAlertingRequest	setAlertSharedCallAppearanceLocations(Boolean alertSharedCallAppearanceLocations)
UserExecutive.UserExecutiveModifyScreeningAlertingRequest	setCallPushRecallNumberOfRings(Integer callPushRecallNumberOfRings)
UserExecutive.UserExecutiveModifyScreeningAlertingRequest	setEnableRollover(Boolean enableRollover)
UserExecutive.UserExecutiveModifyScreeningAlertingRequest	setEnableScreening(Boolean enableScreening)
UserExecutive.UserExecutiveModifyScreeningAlertingRequest	setNextAssistantNumberOfRings(Integer nextAssistantNumberOfRings)
UserExecutive.UserExecutiveModifyScreeningAlertingRequest	setRolloverAction(ExecutiveRolloverActionType rolloverAction)
UserExecutive.UserExecutiveModifyScreeningAlertingRequest	setRolloverForwardToPhoneNumber(String rolloverForwardToPhoneNumber)
UserExecutive.UserExecutiveModifyScreeningAlertingRequest	setRolloverWaitTimeSeconds(Integer rolloverWaitTimeSeconds)
UserExecutive.UserExecutiveModifyScreeningAlertingRequest	setScreeningAlertType(ExecutiveScreeningAlertType screeningAlertType)
UserExecutive.UserExecutiveModifyScreeningAlertingRequest	setUnicodeAlertingCustomCallingLineIdName(String unicodeAlertingCustomCallingLineIdName)
UserExecutive.UserExecutiveModifyScreeningAlertingRequest	setUser(BroadWorksUser user)
UserExecutive.UserExecutiveModifyScreeningAlertingRequest	unsetAlertingCustomCallingLineIdName()
UserExecutive.UserExecutiveModifyScreeningAlertingRequest	unsetAlertingCustomCallingLineIdPhoneNumber()
UserExecutive.UserExecutiveModifyScreeningAlertingRequest	unsetRolloverForwardToPhoneNumber()
UserExecutive.UserExecutiveModifyScreeningAlertingRequest	unsetRolloverWaitTimeSeconds()
UserExecutive.UserExecutiveModifyScreeningAlertingRequest	unsetUnicodeAlertingCustomCallingLineIdName()

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

enableScreening

protected Boolean enableScreening

screeningAlertType

protected ExecutiveScreeningAlertType screeningAlertType

alertBroadWorksMobilityLocation

protected Boolean alertBroadWorksMobilityLocation

alertBroadWorksAnywhereLocations

protected Boolean alertBroadWorksAnywhereLocations

alertSharedCallAppearanceLocations

protected Boolean alertSharedCallAppearanceLocations

alertingMode

protected ExecutiveAlertingMode alertingMode

alertingCallingLineIdNameMode

protected ExecutiveAlertingCallingLineIdNameMode alertingCallingLineIdNameMode

alertingCustomCallingLineIdName

protected Optional<@Size(min=1,max=80) String> alertingCustomCallingLineIdName

unicodeAlertingCustomCallingLineIdName

protected Optional<@Size(min=1,max=80) String> unicodeAlertingCustomCallingLineIdName

alertingCallingLineIdPhoneNumberMode

protected ExecutiveAlertingCallingLineIdPhoneNumberMode alertingCallingLineIdPhoneNumberMode

alertingCustomCallingLineIdPhoneNumber

protected Optional<@Size(min=1,max=23) String> alertingCustomCallingLineIdPhoneNumber

callPushRecallNumberOfRings

protected Integer callPushRecallNumberOfRings

nextAssistantNumberOfRings

protected Integer nextAssistantNumberOfRings

enableRollover

protected Boolean enableRollover

rolloverWaitTimeSeconds

protected Optional<Integer> rolloverWaitTimeSeconds

rolloverAction

protected ExecutiveRolloverActionType rolloverAction

rolloverForwardToPhoneNumber

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

Constructor Details

UserExecutiveModifyScreeningAlertingRequest

public UserExecutiveModifyScreeningAlertingRequest()

UserExecutiveModifyScreeningAlertingRequest

public UserExecutiveModifyScreeningAlertingRequest(BroadWorksUser user)

Method Details

setUser

public UserExecutive.UserExecutiveModifyScreeningAlertingRequest setUser(BroadWorksUser user)

getBroadWorksUser

public BroadWorksUser getBroadWorksUser()

setEnableScreening

public UserExecutive.UserExecutiveModifyScreeningAlertingRequest setEnableScreening(Boolean enableScreening)

getEnableScreening

public Boolean getEnableScreening()

setScreeningAlertType

public UserExecutive.UserExecutiveModifyScreeningAlertingRequest setScreeningAlertType(ExecutiveScreeningAlertType screeningAlertType)

getScreeningAlertType

public ExecutiveScreeningAlertType getScreeningAlertType()

setAlertBroadWorksMobilityLocation

public UserExecutive.UserExecutiveModifyScreeningAlertingRequest setAlertBroadWorksMobilityLocation(Boolean alertBroadWorksMobilityLocation)

getAlertBroadWorksMobilityLocation

public Boolean getAlertBroadWorksMobilityLocation()

setAlertBroadWorksAnywhereLocations

public UserExecutive.UserExecutiveModifyScreeningAlertingRequest setAlertBroadWorksAnywhereLocations(Boolean alertBroadWorksAnywhereLocations)

getAlertBroadWorksAnywhereLocations

public Boolean getAlertBroadWorksAnywhereLocations()

setAlertSharedCallAppearanceLocations

public UserExecutive.UserExecutiveModifyScreeningAlertingRequest setAlertSharedCallAppearanceLocations(Boolean alertSharedCallAppearanceLocations)

getAlertSharedCallAppearanceLocations

public Boolean getAlertSharedCallAppearanceLocations()

setAlertingMode

public UserExecutive.UserExecutiveModifyScreeningAlertingRequest setAlertingMode(ExecutiveAlertingMode alertingMode)

getAlertingMode

public ExecutiveAlertingMode getAlertingMode()

setAlertingCallingLineIdNameMode

public UserExecutive.UserExecutiveModifyScreeningAlertingRequest setAlertingCallingLineIdNameMode(ExecutiveAlertingCallingLineIdNameMode alertingCallingLineIdNameMode)

getAlertingCallingLineIdNameMode

public ExecutiveAlertingCallingLineIdNameMode getAlertingCallingLineIdNameMode()

unsetAlertingCustomCallingLineIdName

public UserExecutive.UserExecutiveModifyScreeningAlertingRequest unsetAlertingCustomCallingLineIdName()

setAlertingCustomCallingLineIdName

public UserExecutive.UserExecutiveModifyScreeningAlertingRequest setAlertingCustomCallingLineIdName(String alertingCustomCallingLineIdName)

getAlertingCustomCallingLineIdName

public Optional<@Size(min=1,max=80) String> getAlertingCustomCallingLineIdName()

unsetUnicodeAlertingCustomCallingLineIdName

public UserExecutive.UserExecutiveModifyScreeningAlertingRequest unsetUnicodeAlertingCustomCallingLineIdName()

setUnicodeAlertingCustomCallingLineIdName

public UserExecutive.UserExecutiveModifyScreeningAlertingRequest setUnicodeAlertingCustomCallingLineIdName(String unicodeAlertingCustomCallingLineIdName)

getUnicodeAlertingCustomCallingLineIdName

public Optional<@Size(min=1,max=80) String> getUnicodeAlertingCustomCallingLineIdName()

setAlertingCallingLineIdPhoneNumberMode

public UserExecutive.UserExecutiveModifyScreeningAlertingRequest setAlertingCallingLineIdPhoneNumberMode(ExecutiveAlertingCallingLineIdPhoneNumberMode alertingCallingLineIdPhoneNumberMode)

getAlertingCallingLineIdPhoneNumberMode

public ExecutiveAlertingCallingLineIdPhoneNumberMode getAlertingCallingLineIdPhoneNumberMode()

unsetAlertingCustomCallingLineIdPhoneNumber

public UserExecutive.UserExecutiveModifyScreeningAlertingRequest unsetAlertingCustomCallingLineIdPhoneNumber()

setAlertingCustomCallingLineIdPhoneNumber

public UserExecutive.UserExecutiveModifyScreeningAlertingRequest setAlertingCustomCallingLineIdPhoneNumber(String alertingCustomCallingLineIdPhoneNumber)

getAlertingCustomCallingLineIdPhoneNumber

public Optional<@Size(min=1,max=23) String> getAlertingCustomCallingLineIdPhoneNumber()

setCallPushRecallNumberOfRings

public UserExecutive.UserExecutiveModifyScreeningAlertingRequest setCallPushRecallNumberOfRings(Integer callPushRecallNumberOfRings)

getCallPushRecallNumberOfRings

public Integer getCallPushRecallNumberOfRings()

setNextAssistantNumberOfRings

public UserExecutive.UserExecutiveModifyScreeningAlertingRequest setNextAssistantNumberOfRings(Integer nextAssistantNumberOfRings)

getNextAssistantNumberOfRings

public Integer getNextAssistantNumberOfRings()

setEnableRollover

public UserExecutive.UserExecutiveModifyScreeningAlertingRequest setEnableRollover(Boolean enableRollover)

getEnableRollover

public Boolean getEnableRollover()

unsetRolloverWaitTimeSeconds

public UserExecutive.UserExecutiveModifyScreeningAlertingRequest unsetRolloverWaitTimeSeconds()

setRolloverWaitTimeSeconds

public UserExecutive.UserExecutiveModifyScreeningAlertingRequest setRolloverWaitTimeSeconds(Integer rolloverWaitTimeSeconds)

getRolloverWaitTimeSeconds

public Optional<Integer> getRolloverWaitTimeSeconds()

setRolloverAction

public UserExecutive.UserExecutiveModifyScreeningAlertingRequest setRolloverAction(ExecutiveRolloverActionType rolloverAction)

getRolloverAction

public ExecutiveRolloverActionType getRolloverAction()

unsetRolloverForwardToPhoneNumber

public UserExecutive.UserExecutiveModifyScreeningAlertingRequest unsetRolloverForwardToPhoneNumber()

setRolloverForwardToPhoneNumber

public UserExecutive.UserExecutiveModifyScreeningAlertingRequest setRolloverForwardToPhoneNumber(String rolloverForwardToPhoneNumber)

getRolloverForwardToPhoneNumber

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

getEmptyObject

public static UserExecutive.UserExecutiveModifyScreeningAlertingRequest 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>