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

Class UserSimultaneousRingFamily.UserSimultaneousRingFamilyGetCriteriaRequest

java.lang.Object

co.ecg.alpaca.toolkit.messaging.request.Request<UserSimultaneousRingFamily.UserSimultaneousRingFamilyGetCriteriaResponse>

co.ecg.alpaca.toolkit.generated.services.UserSimultaneousRingFamily.UserSimultaneousRingFamilyGetCriteriaRequest

Enclosing class:

UserSimultaneousRingFamily

public static class UserSimultaneousRingFamily.UserSimultaneousRingFamilyGetCriteriaRequest
extends Request<UserSimultaneousRingFamily.UserSimultaneousRingFamilyGetCriteriaResponse>

Get a criteria for the user's simultaneous ring family service. The response is either a UserSimultaneousRingFamilyGetCriteriaResponse 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
UserSimultaneousRingFamilyGetCriteriaRequest()
UserSimultaneousRingFamilyGetCriteriaRequest(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 UserSimultaneousRingFamily.UserSimultaneousRingFamilyGetCriteriaRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
UserSimultaneousRingFamily.UserSimultaneousRingFamilyGetCriteriaRequest	setCriteriaName(String criteriaName)
UserSimultaneousRingFamily.UserSimultaneousRingFamilyGetCriteriaRequest	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

UserSimultaneousRingFamilyGetCriteriaRequest

public UserSimultaneousRingFamilyGetCriteriaRequest()

UserSimultaneousRingFamilyGetCriteriaRequest

public UserSimultaneousRingFamilyGetCriteriaRequest(BroadWorksUser user,
 String criteriaName)

Method Details

setUser

public UserSimultaneousRingFamily.UserSimultaneousRingFamilyGetCriteriaRequest setUser(BroadWorksUser user)

getBroadWorksUser

public BroadWorksUser getBroadWorksUser()

setCriteriaName

public UserSimultaneousRingFamily.UserSimultaneousRingFamilyGetCriteriaRequest setCriteriaName(String criteriaName)

getCriteriaName

public String getCriteriaName()

getEmptyObject

public static UserSimultaneousRingFamily.UserSimultaneousRingFamilyGetCriteriaRequest 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<UserSimultaneousRingFamily.UserSimultaneousRingFamilyGetCriteriaResponse>