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

Class UserAlternateNumbers.UserAlternateNumbersModifyRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.services.UserAlternateNumbers.UserAlternateNumbersModifyRequest

Enclosing class:

UserAlternateNumbers

public static class UserAlternateNumbers.UserAlternateNumbersModifyRequest
extends Request<DefaultResponse>

Modify the user level data associated with Alternate Numbers. The following element in AlternateNumberEntry21 datatype is only used in AS mode: description In XS data mode, the request will fail if one of the alternate entry's phone number element represents a currently configured BroadWorks Anywhere location for the user. 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 @Valid AlternateNumberEntry21	alternateEntry01
protected @Valid AlternateNumberEntry21	alternateEntry02
protected @Valid AlternateNumberEntry21	alternateEntry03
protected @Valid AlternateNumberEntry21	alternateEntry04
protected @Valid AlternateNumberEntry21	alternateEntry05
protected @Valid AlternateNumberEntry21	alternateEntry06
protected @Valid AlternateNumberEntry21	alternateEntry07
protected @Valid AlternateNumberEntry21	alternateEntry08
protected @Valid AlternateNumberEntry21	alternateEntry09
protected @Valid AlternateNumberEntry21	alternateEntry10
protected Boolean	distinctiveRing
protected @NotNull @Valid BroadWorksUser	user

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

log

Constructor Summary

Constructors

Constructor	Description
UserAlternateNumbersModifyRequest()
UserAlternateNumbersModifyRequest(BroadWorksUser user)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
AlternateNumberEntry21	getAlternateEntry01()
AlternateNumberEntry21	getAlternateEntry02()
AlternateNumberEntry21	getAlternateEntry03()
AlternateNumberEntry21	getAlternateEntry04()
AlternateNumberEntry21	getAlternateEntry05()
AlternateNumberEntry21	getAlternateEntry06()
AlternateNumberEntry21	getAlternateEntry07()
AlternateNumberEntry21	getAlternateEntry08()
AlternateNumberEntry21	getAlternateEntry09()
AlternateNumberEntry21	getAlternateEntry10()
BroadWorksUser	getBroadWorksUser()
Boolean	getDistinctiveRing()
static UserAlternateNumbers.UserAlternateNumbersModifyRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
UserAlternateNumbers.UserAlternateNumbersModifyRequest	setAlternateEntry01(AlternateNumberEntry21 alternateEntry01)
UserAlternateNumbers.UserAlternateNumbersModifyRequest	setAlternateEntry02(AlternateNumberEntry21 alternateEntry02)
UserAlternateNumbers.UserAlternateNumbersModifyRequest	setAlternateEntry03(AlternateNumberEntry21 alternateEntry03)
UserAlternateNumbers.UserAlternateNumbersModifyRequest	setAlternateEntry04(AlternateNumberEntry21 alternateEntry04)
UserAlternateNumbers.UserAlternateNumbersModifyRequest	setAlternateEntry05(AlternateNumberEntry21 alternateEntry05)
UserAlternateNumbers.UserAlternateNumbersModifyRequest	setAlternateEntry06(AlternateNumberEntry21 alternateEntry06)
UserAlternateNumbers.UserAlternateNumbersModifyRequest	setAlternateEntry07(AlternateNumberEntry21 alternateEntry07)
UserAlternateNumbers.UserAlternateNumbersModifyRequest	setAlternateEntry08(AlternateNumberEntry21 alternateEntry08)
UserAlternateNumbers.UserAlternateNumbersModifyRequest	setAlternateEntry09(AlternateNumberEntry21 alternateEntry09)
UserAlternateNumbers.UserAlternateNumbersModifyRequest	setAlternateEntry10(AlternateNumberEntry21 alternateEntry10)
UserAlternateNumbers.UserAlternateNumbersModifyRequest	setDistinctiveRing(Boolean distinctiveRing)
UserAlternateNumbers.UserAlternateNumbersModifyRequest	setUser(BroadWorksUser user)

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

distinctiveRing

protected Boolean distinctiveRing

alternateEntry01

@Valid
protected @Valid AlternateNumberEntry21 alternateEntry01

alternateEntry02

@Valid
protected @Valid AlternateNumberEntry21 alternateEntry02

alternateEntry03

@Valid
protected @Valid AlternateNumberEntry21 alternateEntry03

alternateEntry04

@Valid
protected @Valid AlternateNumberEntry21 alternateEntry04

alternateEntry05

@Valid
protected @Valid AlternateNumberEntry21 alternateEntry05

alternateEntry06

@Valid
protected @Valid AlternateNumberEntry21 alternateEntry06

alternateEntry07

@Valid
protected @Valid AlternateNumberEntry21 alternateEntry07

alternateEntry08

@Valid
protected @Valid AlternateNumberEntry21 alternateEntry08

alternateEntry09

@Valid
protected @Valid AlternateNumberEntry21 alternateEntry09

alternateEntry10

@Valid
protected @Valid AlternateNumberEntry21 alternateEntry10

Constructor Details

UserAlternateNumbersModifyRequest

public UserAlternateNumbersModifyRequest()

UserAlternateNumbersModifyRequest

public UserAlternateNumbersModifyRequest(BroadWorksUser user)

Method Details

setUser

public UserAlternateNumbers.UserAlternateNumbersModifyRequest setUser(BroadWorksUser user)

getBroadWorksUser

public BroadWorksUser getBroadWorksUser()

setDistinctiveRing

public UserAlternateNumbers.UserAlternateNumbersModifyRequest setDistinctiveRing(Boolean distinctiveRing)

getDistinctiveRing

public Boolean getDistinctiveRing()

setAlternateEntry01

public UserAlternateNumbers.UserAlternateNumbersModifyRequest setAlternateEntry01(AlternateNumberEntry21 alternateEntry01)

getAlternateEntry01

public AlternateNumberEntry21 getAlternateEntry01()

setAlternateEntry02

public UserAlternateNumbers.UserAlternateNumbersModifyRequest setAlternateEntry02(AlternateNumberEntry21 alternateEntry02)

getAlternateEntry02

public AlternateNumberEntry21 getAlternateEntry02()

setAlternateEntry03

public UserAlternateNumbers.UserAlternateNumbersModifyRequest setAlternateEntry03(AlternateNumberEntry21 alternateEntry03)

getAlternateEntry03

public AlternateNumberEntry21 getAlternateEntry03()

setAlternateEntry04

public UserAlternateNumbers.UserAlternateNumbersModifyRequest setAlternateEntry04(AlternateNumberEntry21 alternateEntry04)

getAlternateEntry04

public AlternateNumberEntry21 getAlternateEntry04()

setAlternateEntry05

public UserAlternateNumbers.UserAlternateNumbersModifyRequest setAlternateEntry05(AlternateNumberEntry21 alternateEntry05)

getAlternateEntry05

public AlternateNumberEntry21 getAlternateEntry05()

setAlternateEntry06

public UserAlternateNumbers.UserAlternateNumbersModifyRequest setAlternateEntry06(AlternateNumberEntry21 alternateEntry06)

getAlternateEntry06

public AlternateNumberEntry21 getAlternateEntry06()

setAlternateEntry07

public UserAlternateNumbers.UserAlternateNumbersModifyRequest setAlternateEntry07(AlternateNumberEntry21 alternateEntry07)

getAlternateEntry07

public AlternateNumberEntry21 getAlternateEntry07()

setAlternateEntry08

public UserAlternateNumbers.UserAlternateNumbersModifyRequest setAlternateEntry08(AlternateNumberEntry21 alternateEntry08)

getAlternateEntry08

public AlternateNumberEntry21 getAlternateEntry08()

setAlternateEntry09

public UserAlternateNumbers.UserAlternateNumbersModifyRequest setAlternateEntry09(AlternateNumberEntry21 alternateEntry09)

getAlternateEntry09

public AlternateNumberEntry21 getAlternateEntry09()

setAlternateEntry10

public UserAlternateNumbers.UserAlternateNumbersModifyRequest setAlternateEntry10(AlternateNumberEntry21 alternateEntry10)

getAlternateEntry10

public AlternateNumberEntry21 getAlternateEntry10()

getEmptyObject

public static UserAlternateNumbers.UserAlternateNumbersModifyRequest 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>