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

Class UserCustomRingback.UserCustomRingbackUserGetCriteriaRequest

java.lang.Object

co.ecg.alpaca.toolkit.messaging.request.Request<UserCustomRingback.UserCustomRingbackUserGetCriteriaResponse>

co.ecg.alpaca.toolkit.generated.services.UserCustomRingback.UserCustomRingbackUserGetCriteriaRequest

Enclosing class:

UserCustomRingback

public static class UserCustomRingback.UserCustomRingbackUserGetCriteriaRequest
extends Request<UserCustomRingback.UserCustomRingbackUserGetCriteriaResponse>

Get a criteria for the user's custom ringback service. The response is either a UserCustomRingbackUserGetCriteriaResponse21 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
UserCustomRingbackUserGetCriteriaRequest()
UserCustomRingbackUserGetCriteriaRequest(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 UserCustomRingback.UserCustomRingbackUserGetCriteriaRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
UserCustomRingback.UserCustomRingbackUserGetCriteriaRequest	setCriteriaName(String criteriaName)
UserCustomRingback.UserCustomRingbackUserGetCriteriaRequest	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

UserCustomRingbackUserGetCriteriaRequest

public UserCustomRingbackUserGetCriteriaRequest()

UserCustomRingbackUserGetCriteriaRequest

public UserCustomRingbackUserGetCriteriaRequest(BroadWorksUser user,
 String criteriaName)

Method Details

setUser

public UserCustomRingback.UserCustomRingbackUserGetCriteriaRequest setUser(BroadWorksUser user)

getBroadWorksUser

public BroadWorksUser getBroadWorksUser()

setCriteriaName

public UserCustomRingback.UserCustomRingbackUserGetCriteriaRequest setCriteriaName(String criteriaName)

getCriteriaName

public String getCriteriaName()

getEmptyObject

public static UserCustomRingback.UserCustomRingbackUserGetCriteriaRequest 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<UserCustomRingback.UserCustomRingbackUserGetCriteriaResponse>