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

Class UserSequentialRing.UserSequentialRingGetCriteriaRequest

java.lang.Object

co.ecg.alpaca.toolkit.messaging.request.Request<UserSequentialRing.UserSequentialRingGetCriteriaResponse>

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

Enclosing class:

UserSequentialRing

public static class UserSequentialRing.UserSequentialRingGetCriteriaRequest
extends Request<UserSequentialRing.UserSequentialRingGetCriteriaResponse>

Get a criteria for the user's sequential ring service. The response is either a UserSequentialRingGetCriteriaResponse16 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 @NotNull @Size(min=1,max=50) String	criteriaName
protected @NotNull @Valid BroadWorksUser	user

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

log

Constructor Summary

Constructors

Constructor	Description
UserSequentialRingGetCriteriaRequest()
UserSequentialRingGetCriteriaRequest(BroadWorksUser user, String criteriaName)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
BroadWorksUser	getBroadWorksUser()
String	getCriteriaName()
static UserSequentialRing.UserSequentialRingGetCriteriaRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
UserSequentialRing.UserSequentialRingGetCriteriaRequest	setCriteriaName(String criteriaName)
UserSequentialRing.UserSequentialRingGetCriteriaRequest	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

criteriaName

@NotNull
@Size(min=1,
      max=50)
protected @NotNull @Size(min=1,max=50) String criteriaName

Constructor Details

UserSequentialRingGetCriteriaRequest

public UserSequentialRingGetCriteriaRequest()

UserSequentialRingGetCriteriaRequest

public UserSequentialRingGetCriteriaRequest(BroadWorksUser user,
 String criteriaName)

Method Details

setUser

public UserSequentialRing.UserSequentialRingGetCriteriaRequest setUser(BroadWorksUser user)

getBroadWorksUser

public BroadWorksUser getBroadWorksUser()

setCriteriaName

public UserSequentialRing.UserSequentialRingGetCriteriaRequest setCriteriaName(String criteriaName)

getCriteriaName

public String getCriteriaName()

getEmptyObject

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