Class UserRemoteOffice.UserRemoteOfficeModifyRequest
java.lang.Object
co.ecg.alpaca.toolkit.messaging.request.Request<DefaultResponse>
co.ecg.alpaca.toolkit.generated.services.UserRemoteOffice.UserRemoteOfficeModifyRequest
- Enclosing class:
- UserRemoteOffice
public static class UserRemoteOffice.UserRemoteOfficeModifyRequest extends Request<DefaultResponse>
Modify the user level data associated with Remote Office. 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 Boolean
isActive
protected Optional<@Size(min=1,max=161) String>
remoteOfficePhoneNumber
protected @NotNull @Valid BroadWorksUser
user
-
Constructor Summary
Constructors Constructor Description UserRemoteOfficeModifyRequest()
UserRemoteOfficeModifyRequest(BroadWorksUser user)
-
Method Summary
Modifier and Type Method Description void
formRequest()
Forms the XML Document for this Request Object.BroadWorksUser
getBroadWorksUser()
static UserRemoteOffice.UserRemoteOfficeModifyRequest
getEmptyObject(BroadWorksServer broadWorksServer)
Retrieves this object with minimal setup.Boolean
getIsActive()
Optional<@Size(min=1,max=161) String>
getRemoteOfficePhoneNumber()
UserRemoteOffice.UserRemoteOfficeModifyRequest
setIsActive(Boolean isActive)
UserRemoteOffice.UserRemoteOfficeModifyRequest
setRemoteOfficePhoneNumber(String remoteOfficePhoneNumber)
UserRemoteOffice.UserRemoteOfficeModifyRequest
setUser(BroadWorksUser user)
UserRemoteOffice.UserRemoteOfficeModifyRequest
unsetRemoteOfficePhoneNumber()
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, isMemberOfBundle, isValid, setBroadWorksServer, setCommandElement, setCommandType, setDomDocument, setEcho, setMemberOfBundle, setRequestId, setRequestTimeoutMillis, setResponseClass, setRetries, setRetryCodes, setRootElement, toString, validate
-
Field Details
-
Constructor Details
-
UserRemoteOfficeModifyRequest
public UserRemoteOfficeModifyRequest() -
UserRemoteOfficeModifyRequest
-
-
Method Details
-
setUser
-
getBroadWorksUser
-
setIsActive
-
getIsActive
-
unsetRemoteOfficePhoneNumber
-
setRemoteOfficePhoneNumber
public UserRemoteOffice.UserRemoteOfficeModifyRequest setRemoteOfficePhoneNumber(String remoteOfficePhoneNumber) -
getRemoteOfficePhoneNumber
-
getEmptyObject
public static UserRemoteOffice.UserRemoteOfficeModifyRequest 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 classRequest<DefaultResponse>
-