Class UserSequentialRing.UserSequentialRingDeleteCriteriaRequest
- java.lang.Object
-
- co.ecg.alpaca.toolkit.messaging.request.Request<DefaultResponse>
-
- co.ecg.alpaca.toolkit.generated.services.UserSequentialRing.UserSequentialRingDeleteCriteriaRequest
-
- Enclosing class:
- UserSequentialRing
public static class UserSequentialRing.UserSequentialRingDeleteCriteriaRequest extends Request<DefaultResponse>
Delete a criteria from the user's sequential ring service. 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 @NotNull @Size(min=1,max=50) StringcriteriaNameprotected @NotNull @Valid BroadWorksUseruser
-
Constructor Summary
Constructors Constructor Description UserSequentialRingDeleteCriteriaRequest()UserSequentialRingDeleteCriteriaRequest(BroadWorksUser user, String criteriaName)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description voidformRequest()Forms the XML Document for this Request Object.BroadWorksUsergetBroadWorksUser()StringgetCriteriaName()static UserSequentialRing.UserSequentialRingDeleteCriteriaRequestgetEmptyObject(BroadWorksServer broadWorksServer)Retrieves this object with minimal setup.UserSequentialRing.UserSequentialRingDeleteCriteriaRequestsetCriteriaName(String criteriaName)UserSequentialRing.UserSequentialRingDeleteCriteriaRequestsetUser(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
-
-
-
-
Field Detail
-
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 Detail
-
UserSequentialRingDeleteCriteriaRequest
public UserSequentialRingDeleteCriteriaRequest()
-
UserSequentialRingDeleteCriteriaRequest
public UserSequentialRingDeleteCriteriaRequest(BroadWorksUser user, String criteriaName)
-
-
Method Detail
-
setUser
public UserSequentialRing.UserSequentialRingDeleteCriteriaRequest setUser(BroadWorksUser user)
-
getBroadWorksUser
public BroadWorksUser getBroadWorksUser()
-
setCriteriaName
public UserSequentialRing.UserSequentialRingDeleteCriteriaRequest setCriteriaName(String criteriaName)
-
getCriteriaName
public String getCriteriaName()
-
getEmptyObject
public static UserSequentialRing.UserSequentialRingDeleteCriteriaRequest 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:
formRequestin classRequest<DefaultResponse>
-
-