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

Class UserSequentialRing.UserSequentialRingModifyRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.services.UserSequentialRing.UserSequentialRingModifyRequest

Enclosing class:

UserSequentialRing

public static class UserSequentialRing.UserSequentialRingModifyRequest
extends Request<DefaultResponse>

Modify the user's sequential ring service setting. 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 SequentialRingNumberOfRings	baseLocationNumberOfRings
protected Boolean	callerMayStopSearch
protected Boolean	continueIfBaseLocationIsBusy
protected @Valid CriteriaActivation[]	criteriaActivation
protected @Valid SequentialRingLocationModify	location01
protected @Valid SequentialRingLocationModify	location02
protected @Valid SequentialRingLocationModify	location03
protected @Valid SequentialRingLocationModify	location04
protected @Valid SequentialRingLocationModify	location05
protected Boolean	ringBaseLocationFirst
protected @NotNull @Valid BroadWorksUser	user

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

log

Constructor Summary

Constructors

Constructor	Description
UserSequentialRingModifyRequest()
UserSequentialRingModifyRequest(BroadWorksUser user)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
SequentialRingNumberOfRings	getBaseLocationNumberOfRings()
BroadWorksUser	getBroadWorksUser()
Boolean	getCallerMayStopSearch()
Boolean	getContinueIfBaseLocationIsBusy()
CriteriaActivation[]	getCriteriaActivation()
static UserSequentialRing.UserSequentialRingModifyRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
SequentialRingLocationModify	getLocation01()
SequentialRingLocationModify	getLocation02()
SequentialRingLocationModify	getLocation03()
SequentialRingLocationModify	getLocation04()
SequentialRingLocationModify	getLocation05()
Boolean	getRingBaseLocationFirst()
UserSequentialRing.UserSequentialRingModifyRequest	setBaseLocationNumberOfRings(SequentialRingNumberOfRings baseLocationNumberOfRings)
UserSequentialRing.UserSequentialRingModifyRequest	setCallerMayStopSearch(Boolean callerMayStopSearch)
UserSequentialRing.UserSequentialRingModifyRequest	setContinueIfBaseLocationIsBusy(Boolean continueIfBaseLocationIsBusy)
UserSequentialRing.UserSequentialRingModifyRequest	setCriteriaActivation(CriteriaActivation... criteriaActivation)
UserSequentialRing.UserSequentialRingModifyRequest	setLocation01(SequentialRingLocationModify location01)
UserSequentialRing.UserSequentialRingModifyRequest	setLocation02(SequentialRingLocationModify location02)
UserSequentialRing.UserSequentialRingModifyRequest	setLocation03(SequentialRingLocationModify location03)
UserSequentialRing.UserSequentialRingModifyRequest	setLocation04(SequentialRingLocationModify location04)
UserSequentialRing.UserSequentialRingModifyRequest	setLocation05(SequentialRingLocationModify location05)
UserSequentialRing.UserSequentialRingModifyRequest	setRingBaseLocationFirst(Boolean ringBaseLocationFirst)
UserSequentialRing.UserSequentialRingModifyRequest	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

ringBaseLocationFirst

protected Boolean ringBaseLocationFirst

baseLocationNumberOfRings

protected SequentialRingNumberOfRings baseLocationNumberOfRings

continueIfBaseLocationIsBusy

protected Boolean continueIfBaseLocationIsBusy

callerMayStopSearch

protected Boolean callerMayStopSearch

location01

@Valid
protected @Valid SequentialRingLocationModify location01

location02

@Valid
protected @Valid SequentialRingLocationModify location02

location03

@Valid
protected @Valid SequentialRingLocationModify location03

location04

@Valid
protected @Valid SequentialRingLocationModify location04

location05

@Valid
protected @Valid SequentialRingLocationModify location05

criteriaActivation

@Valid
protected @Valid CriteriaActivation[] criteriaActivation

Constructor Details

UserSequentialRingModifyRequest

public UserSequentialRingModifyRequest()

UserSequentialRingModifyRequest

public UserSequentialRingModifyRequest(BroadWorksUser user)

Method Details

setUser

public UserSequentialRing.UserSequentialRingModifyRequest setUser(BroadWorksUser user)

getBroadWorksUser

public BroadWorksUser getBroadWorksUser()

setRingBaseLocationFirst

public UserSequentialRing.UserSequentialRingModifyRequest setRingBaseLocationFirst(Boolean ringBaseLocationFirst)

getRingBaseLocationFirst

public Boolean getRingBaseLocationFirst()

setBaseLocationNumberOfRings

public UserSequentialRing.UserSequentialRingModifyRequest setBaseLocationNumberOfRings(SequentialRingNumberOfRings baseLocationNumberOfRings)

getBaseLocationNumberOfRings

public SequentialRingNumberOfRings getBaseLocationNumberOfRings()

setContinueIfBaseLocationIsBusy

public UserSequentialRing.UserSequentialRingModifyRequest setContinueIfBaseLocationIsBusy(Boolean continueIfBaseLocationIsBusy)

getContinueIfBaseLocationIsBusy

public Boolean getContinueIfBaseLocationIsBusy()

setCallerMayStopSearch

public UserSequentialRing.UserSequentialRingModifyRequest setCallerMayStopSearch(Boolean callerMayStopSearch)

getCallerMayStopSearch

public Boolean getCallerMayStopSearch()

setLocation01

public UserSequentialRing.UserSequentialRingModifyRequest setLocation01(SequentialRingLocationModify location01)

getLocation01

public SequentialRingLocationModify getLocation01()

setLocation02

public UserSequentialRing.UserSequentialRingModifyRequest setLocation02(SequentialRingLocationModify location02)

getLocation02

public SequentialRingLocationModify getLocation02()

setLocation03

public UserSequentialRing.UserSequentialRingModifyRequest setLocation03(SequentialRingLocationModify location03)

getLocation03

public SequentialRingLocationModify getLocation03()

setLocation04

public UserSequentialRing.UserSequentialRingModifyRequest setLocation04(SequentialRingLocationModify location04)

getLocation04

public SequentialRingLocationModify getLocation04()

setLocation05

public UserSequentialRing.UserSequentialRingModifyRequest setLocation05(SequentialRingLocationModify location05)

getLocation05

public SequentialRingLocationModify getLocation05()

setCriteriaActivation

public UserSequentialRing.UserSequentialRingModifyRequest setCriteriaActivation(CriteriaActivation... criteriaActivation)

getCriteriaActivation

public CriteriaActivation[] getCriteriaActivation()

getEmptyObject

public static UserSequentialRing.UserSequentialRingModifyRequest 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>