Package co.ecg.alpaca.toolkit.generated

Class BroadWorksAnywherePortal.UserBroadWorksAnywhereModifyPhoneNumberRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.BroadWorksAnywherePortal.UserBroadWorksAnywhereModifyPhoneNumberRequest

Enclosing class:

BroadWorksAnywherePortal

public static class BroadWorksAnywherePortal.UserBroadWorksAnywhereModifyPhoneNumberRequest
extends Request<DefaultResponse>

Modify a BroadWorks Anywhere phone number In XS data mode, the request will fail if the phoneNumber element represents the user's directory number or one of the user's alternate numbers. The response is either a SuccessResponse or an 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	answerConfirmationRequired
protected Boolean	broadworksCallControl
protected @Valid CriteriaActivation[]	criteriaActivation
protected Optional<@Size(min=1,max=80) String>	description
protected Boolean	isActive
protected @Size(min=1,max=23) String	newPhoneNumber
protected Optional<@Size(min=1,max=161) String>	outboundAlternateNumber
protected @NotNull @Size(min=1,max=23) String	phoneNumber
protected Boolean	useDiversionInhibitor
protected @NotNull @Valid BroadWorksUser	user

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

log

Constructor Summary

Constructors

Constructor	Description
UserBroadWorksAnywhereModifyPhoneNumberRequest()
UserBroadWorksAnywhereModifyPhoneNumberRequest(BroadWorksUser user, String phoneNumber)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
Boolean	getAnswerConfirmationRequired()
Boolean	getBroadworksCallControl()
BroadWorksUser	getBroadWorksUser()
CriteriaActivation[]	getCriteriaActivation()
Optional<@Size(min=1,max=80) String>	getDescription()
static BroadWorksAnywherePortal.UserBroadWorksAnywhereModifyPhoneNumberRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
Boolean	getIsActive()
String	getNewPhoneNumber()
Optional<@Size(min=1,max=161) String>	getOutboundAlternateNumber()
String	getPhoneNumber()
Boolean	getUseDiversionInhibitor()
BroadWorksAnywherePortal.UserBroadWorksAnywhereModifyPhoneNumberRequest	setAnswerConfirmationRequired(Boolean answerConfirmationRequired)
BroadWorksAnywherePortal.UserBroadWorksAnywhereModifyPhoneNumberRequest	setBroadworksCallControl(Boolean broadworksCallControl)
BroadWorksAnywherePortal.UserBroadWorksAnywhereModifyPhoneNumberRequest	setCriteriaActivation(CriteriaActivation... criteriaActivation)
BroadWorksAnywherePortal.UserBroadWorksAnywhereModifyPhoneNumberRequest	setDescription(String description)
BroadWorksAnywherePortal.UserBroadWorksAnywhereModifyPhoneNumberRequest	setIsActive(Boolean isActive)
BroadWorksAnywherePortal.UserBroadWorksAnywhereModifyPhoneNumberRequest	setNewPhoneNumber(String newPhoneNumber)
BroadWorksAnywherePortal.UserBroadWorksAnywhereModifyPhoneNumberRequest	setOutboundAlternateNumber(String outboundAlternateNumber)
BroadWorksAnywherePortal.UserBroadWorksAnywhereModifyPhoneNumberRequest	setPhoneNumber(String phoneNumber)
BroadWorksAnywherePortal.UserBroadWorksAnywhereModifyPhoneNumberRequest	setUseDiversionInhibitor(Boolean useDiversionInhibitor)
BroadWorksAnywherePortal.UserBroadWorksAnywhereModifyPhoneNumberRequest	setUser(BroadWorksUser user)
BroadWorksAnywherePortal.UserBroadWorksAnywhereModifyPhoneNumberRequest	unsetDescription()
BroadWorksAnywherePortal.UserBroadWorksAnywhereModifyPhoneNumberRequest	unsetOutboundAlternateNumber()

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

phoneNumber

@NotNull
@Size(min=1,
      max=23)
protected @NotNull @Size(min=1,max=23) String phoneNumber

newPhoneNumber

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

description

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

isActive

protected Boolean isActive

outboundAlternateNumber

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

broadworksCallControl

protected Boolean broadworksCallControl

useDiversionInhibitor

protected Boolean useDiversionInhibitor

answerConfirmationRequired

protected Boolean answerConfirmationRequired

criteriaActivation

@Valid
protected @Valid CriteriaActivation[] criteriaActivation

Constructor Details

UserBroadWorksAnywhereModifyPhoneNumberRequest

public UserBroadWorksAnywhereModifyPhoneNumberRequest()

UserBroadWorksAnywhereModifyPhoneNumberRequest

public UserBroadWorksAnywhereModifyPhoneNumberRequest(BroadWorksUser user,
 String phoneNumber)

Method Details

setUser

public BroadWorksAnywherePortal.UserBroadWorksAnywhereModifyPhoneNumberRequest setUser(BroadWorksUser user)

getBroadWorksUser

public BroadWorksUser getBroadWorksUser()

setPhoneNumber

public BroadWorksAnywherePortal.UserBroadWorksAnywhereModifyPhoneNumberRequest setPhoneNumber(String phoneNumber)

getPhoneNumber

public String getPhoneNumber()

setNewPhoneNumber

public BroadWorksAnywherePortal.UserBroadWorksAnywhereModifyPhoneNumberRequest setNewPhoneNumber(String newPhoneNumber)

getNewPhoneNumber

public String getNewPhoneNumber()

unsetDescription

public BroadWorksAnywherePortal.UserBroadWorksAnywhereModifyPhoneNumberRequest unsetDescription()

setDescription

public BroadWorksAnywherePortal.UserBroadWorksAnywhereModifyPhoneNumberRequest setDescription(String description)

getDescription

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

setIsActive

public BroadWorksAnywherePortal.UserBroadWorksAnywhereModifyPhoneNumberRequest setIsActive(Boolean isActive)

getIsActive

public Boolean getIsActive()

unsetOutboundAlternateNumber

public BroadWorksAnywherePortal.UserBroadWorksAnywhereModifyPhoneNumberRequest unsetOutboundAlternateNumber()

setOutboundAlternateNumber

public BroadWorksAnywherePortal.UserBroadWorksAnywhereModifyPhoneNumberRequest setOutboundAlternateNumber(String outboundAlternateNumber)

getOutboundAlternateNumber

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

setBroadworksCallControl

public BroadWorksAnywherePortal.UserBroadWorksAnywhereModifyPhoneNumberRequest setBroadworksCallControl(Boolean broadworksCallControl)

getBroadworksCallControl

public Boolean getBroadworksCallControl()

setUseDiversionInhibitor

public BroadWorksAnywherePortal.UserBroadWorksAnywhereModifyPhoneNumberRequest setUseDiversionInhibitor(Boolean useDiversionInhibitor)

getUseDiversionInhibitor

public Boolean getUseDiversionInhibitor()

setAnswerConfirmationRequired

public BroadWorksAnywherePortal.UserBroadWorksAnywhereModifyPhoneNumberRequest setAnswerConfirmationRequired(Boolean answerConfirmationRequired)

getAnswerConfirmationRequired

public Boolean getAnswerConfirmationRequired()

setCriteriaActivation

public BroadWorksAnywherePortal.UserBroadWorksAnywhereModifyPhoneNumberRequest setCriteriaActivation(CriteriaActivation... criteriaActivation)

getCriteriaActivation

public CriteriaActivation[] getCriteriaActivation()

getEmptyObject

public static BroadWorksAnywherePortal.UserBroadWorksAnywhereModifyPhoneNumberRequest 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>