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

Class UserIntercept.UserInterceptUserModifyRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.services.UserIntercept.UserInterceptUserModifyRequest

Enclosing class:

UserIntercept

public static class UserIntercept.UserInterceptUserModifyRequest
extends Request<DefaultResponse>

Modify the user's intercept user service settings. 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: exemptInboundMobilityCalls exemptOutboundMobilityCalls disableParallelRingingToNetworkLocations

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	alternateBlockingAnnouncement
protected AnnouncementSelection	announcementSelection
protected @Valid LabeledMediaFileResource	audioFile
protected Boolean	disableParallelRingingToNetworkLocations
protected Boolean	exemptInboundMobilityCalls
protected Boolean	exemptOutboundMobilityCalls
protected InterceptInboundCall	inboundCallMode
protected Boolean	isActive
protected Optional<@Size(min=1,max=23) String>	newPhoneNumber
protected InterceptOutboundCall	outboundCallMode
protected Optional<@Size(min=1,max=161) String>	outboundReroutePhoneNumber
protected Boolean	playNewPhoneNumber
protected Boolean	rerouteOutboundCalls
protected Boolean	routeToVoiceMail
protected Boolean	transferOnZeroToPhoneNumber
protected Optional<@Size(min=1,max=30) String>	transferPhoneNumber
protected @NotNull @Valid BroadWorksUser	user
protected @Valid LabeledMediaFileResource	videoFile

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

log

Constructor Summary

Constructors

Constructor	Description
UserInterceptUserModifyRequest()
UserInterceptUserModifyRequest(BroadWorksUser user)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
Boolean	getAlternateBlockingAnnouncement()
AnnouncementSelection	getAnnouncementSelection()
LabeledMediaFileResource	getAudioFile()
BroadWorksUser	getBroadWorksUser()
Boolean	getDisableParallelRingingToNetworkLocations()
static UserIntercept.UserInterceptUserModifyRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
Boolean	getExemptInboundMobilityCalls()
Boolean	getExemptOutboundMobilityCalls()
InterceptInboundCall	getInboundCallMode()
Boolean	getIsActive()
Optional<@Size(min=1,max=23) String>	getNewPhoneNumber()
InterceptOutboundCall	getOutboundCallMode()
Optional<@Size(min=1,max=161) String>	getOutboundReroutePhoneNumber()
Boolean	getPlayNewPhoneNumber()
Boolean	getRerouteOutboundCalls()
Boolean	getRouteToVoiceMail()
Boolean	getTransferOnZeroToPhoneNumber()
Optional<@Size(min=1,max=30) String>	getTransferPhoneNumber()
LabeledMediaFileResource	getVideoFile()
UserIntercept.UserInterceptUserModifyRequest	setAlternateBlockingAnnouncement(Boolean alternateBlockingAnnouncement)
UserIntercept.UserInterceptUserModifyRequest	setAnnouncementSelection(AnnouncementSelection announcementSelection)
UserIntercept.UserInterceptUserModifyRequest	setAudioFile(LabeledMediaFileResource audioFile)
UserIntercept.UserInterceptUserModifyRequest	setDisableParallelRingingToNetworkLocations(Boolean disableParallelRingingToNetworkLocations)
UserIntercept.UserInterceptUserModifyRequest	setExemptInboundMobilityCalls(Boolean exemptInboundMobilityCalls)
UserIntercept.UserInterceptUserModifyRequest	setExemptOutboundMobilityCalls(Boolean exemptOutboundMobilityCalls)
UserIntercept.UserInterceptUserModifyRequest	setInboundCallMode(InterceptInboundCall inboundCallMode)
UserIntercept.UserInterceptUserModifyRequest	setIsActive(Boolean isActive)
UserIntercept.UserInterceptUserModifyRequest	setNewPhoneNumber(String newPhoneNumber)
UserIntercept.UserInterceptUserModifyRequest	setOutboundCallMode(InterceptOutboundCall outboundCallMode)
UserIntercept.UserInterceptUserModifyRequest	setOutboundReroutePhoneNumber(String outboundReroutePhoneNumber)
UserIntercept.UserInterceptUserModifyRequest	setPlayNewPhoneNumber(Boolean playNewPhoneNumber)
UserIntercept.UserInterceptUserModifyRequest	setRerouteOutboundCalls(Boolean rerouteOutboundCalls)
UserIntercept.UserInterceptUserModifyRequest	setRouteToVoiceMail(Boolean routeToVoiceMail)
UserIntercept.UserInterceptUserModifyRequest	setTransferOnZeroToPhoneNumber(Boolean transferOnZeroToPhoneNumber)
UserIntercept.UserInterceptUserModifyRequest	setTransferPhoneNumber(String transferPhoneNumber)
UserIntercept.UserInterceptUserModifyRequest	setUser(BroadWorksUser user)
UserIntercept.UserInterceptUserModifyRequest	setVideoFile(LabeledMediaFileResource videoFile)
UserIntercept.UserInterceptUserModifyRequest	unsetNewPhoneNumber()
UserIntercept.UserInterceptUserModifyRequest	unsetOutboundReroutePhoneNumber()
UserIntercept.UserInterceptUserModifyRequest	unsetTransferPhoneNumber()

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

isActive

protected Boolean isActive

announcementSelection

protected AnnouncementSelection announcementSelection

audioFile

@Valid
protected @Valid LabeledMediaFileResource audioFile

videoFile

@Valid
protected @Valid LabeledMediaFileResource videoFile

inboundCallMode

protected InterceptInboundCall inboundCallMode

alternateBlockingAnnouncement

protected Boolean alternateBlockingAnnouncement

exemptInboundMobilityCalls

protected Boolean exemptInboundMobilityCalls

disableParallelRingingToNetworkLocations

protected Boolean disableParallelRingingToNetworkLocations

routeToVoiceMail

protected Boolean routeToVoiceMail

playNewPhoneNumber

protected Boolean playNewPhoneNumber

newPhoneNumber

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

transferOnZeroToPhoneNumber

protected Boolean transferOnZeroToPhoneNumber

transferPhoneNumber

protected Optional<@Size(min=1,max=30) String> transferPhoneNumber

outboundCallMode

protected InterceptOutboundCall outboundCallMode

exemptOutboundMobilityCalls

protected Boolean exemptOutboundMobilityCalls

rerouteOutboundCalls

protected Boolean rerouteOutboundCalls

outboundReroutePhoneNumber

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

Constructor Details

UserInterceptUserModifyRequest

public UserInterceptUserModifyRequest()

UserInterceptUserModifyRequest

public UserInterceptUserModifyRequest(BroadWorksUser user)

Method Details

setUser

public UserIntercept.UserInterceptUserModifyRequest setUser(BroadWorksUser user)

getBroadWorksUser

public BroadWorksUser getBroadWorksUser()

setIsActive

public UserIntercept.UserInterceptUserModifyRequest setIsActive(Boolean isActive)

getIsActive

public Boolean getIsActive()

setAnnouncementSelection

public UserIntercept.UserInterceptUserModifyRequest setAnnouncementSelection(AnnouncementSelection announcementSelection)

getAnnouncementSelection

public AnnouncementSelection getAnnouncementSelection()

setAudioFile

public UserIntercept.UserInterceptUserModifyRequest setAudioFile(LabeledMediaFileResource audioFile)

getAudioFile

public LabeledMediaFileResource getAudioFile()

setVideoFile

public UserIntercept.UserInterceptUserModifyRequest setVideoFile(LabeledMediaFileResource videoFile)

getVideoFile

public LabeledMediaFileResource getVideoFile()

setInboundCallMode

public UserIntercept.UserInterceptUserModifyRequest setInboundCallMode(InterceptInboundCall inboundCallMode)

getInboundCallMode

public InterceptInboundCall getInboundCallMode()

setAlternateBlockingAnnouncement

public UserIntercept.UserInterceptUserModifyRequest setAlternateBlockingAnnouncement(Boolean alternateBlockingAnnouncement)

getAlternateBlockingAnnouncement

public Boolean getAlternateBlockingAnnouncement()

setExemptInboundMobilityCalls

public UserIntercept.UserInterceptUserModifyRequest setExemptInboundMobilityCalls(Boolean exemptInboundMobilityCalls)

getExemptInboundMobilityCalls

public Boolean getExemptInboundMobilityCalls()

setDisableParallelRingingToNetworkLocations

public UserIntercept.UserInterceptUserModifyRequest setDisableParallelRingingToNetworkLocations(Boolean disableParallelRingingToNetworkLocations)

getDisableParallelRingingToNetworkLocations

public Boolean getDisableParallelRingingToNetworkLocations()

setRouteToVoiceMail

public UserIntercept.UserInterceptUserModifyRequest setRouteToVoiceMail(Boolean routeToVoiceMail)

getRouteToVoiceMail

public Boolean getRouteToVoiceMail()

setPlayNewPhoneNumber

public UserIntercept.UserInterceptUserModifyRequest setPlayNewPhoneNumber(Boolean playNewPhoneNumber)

getPlayNewPhoneNumber

public Boolean getPlayNewPhoneNumber()

unsetNewPhoneNumber

public UserIntercept.UserInterceptUserModifyRequest unsetNewPhoneNumber()

setNewPhoneNumber

public UserIntercept.UserInterceptUserModifyRequest setNewPhoneNumber(String newPhoneNumber)

getNewPhoneNumber

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

setTransferOnZeroToPhoneNumber

public UserIntercept.UserInterceptUserModifyRequest setTransferOnZeroToPhoneNumber(Boolean transferOnZeroToPhoneNumber)

getTransferOnZeroToPhoneNumber

public Boolean getTransferOnZeroToPhoneNumber()

unsetTransferPhoneNumber

public UserIntercept.UserInterceptUserModifyRequest unsetTransferPhoneNumber()

setTransferPhoneNumber

public UserIntercept.UserInterceptUserModifyRequest setTransferPhoneNumber(String transferPhoneNumber)

getTransferPhoneNumber

public Optional<@Size(min=1,max=30) String> getTransferPhoneNumber()

setOutboundCallMode

public UserIntercept.UserInterceptUserModifyRequest setOutboundCallMode(InterceptOutboundCall outboundCallMode)

getOutboundCallMode

public InterceptOutboundCall getOutboundCallMode()

setExemptOutboundMobilityCalls

public UserIntercept.UserInterceptUserModifyRequest setExemptOutboundMobilityCalls(Boolean exemptOutboundMobilityCalls)

getExemptOutboundMobilityCalls

public Boolean getExemptOutboundMobilityCalls()

setRerouteOutboundCalls

public UserIntercept.UserInterceptUserModifyRequest setRerouteOutboundCalls(Boolean rerouteOutboundCalls)

getRerouteOutboundCalls

public Boolean getRerouteOutboundCalls()

unsetOutboundReroutePhoneNumber

public UserIntercept.UserInterceptUserModifyRequest unsetOutboundReroutePhoneNumber()

setOutboundReroutePhoneNumber

public UserIntercept.UserInterceptUserModifyRequest setOutboundReroutePhoneNumber(String outboundReroutePhoneNumber)

getOutboundReroutePhoneNumber

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

getEmptyObject

public static UserIntercept.UserInterceptUserModifyRequest 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>