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

Class UserCommunicationBarringUserControl.UserCommunicationBarringUserControlModifyRequest

java.lang.Object

co.ecg.alpaca.toolkit.messaging.request.Request<DefaultResponse>

co.ecg.alpaca.toolkit.generated.services.UserCommunicationBarringUserControl.UserCommunicationBarringUserControlModifyRequest

Enclosing class:

UserCommunicationBarringUserControl

public static class UserCommunicationBarringUserControl.UserCommunicationBarringUserControlModifyRequest
extends Request<DefaultResponse>

Enabling a profile automatically disables the currently active profile. Also allows the passcode for the service to be modified and the lockout to be reset. Admins only need to populate the newPasscode field when changing the passcode. Users must populate both the oldPasscode and new Passcode fields when changing the passcode. The response is either SuccessResponse or 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 Optional<Integer>	enableProfile
protected @Size(min=1,max=30) String	newPasscode
protected @Size(min=1,max=30) String	oldPasscode
protected @AssertTrue Boolean	resetLockout
protected @NotNull @Valid BroadWorksUser	user

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

log

Constructor Summary

Constructors

Constructor	Description
UserCommunicationBarringUserControlModifyRequest()
UserCommunicationBarringUserControlModifyRequest(BroadWorksUser user)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
BroadWorksUser	getBroadWorksUser()
static UserCommunicationBarringUserControl.UserCommunicationBarringUserControlModifyRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
Optional<Integer>	getEnableProfile()
String	getNewPasscode()
String	getOldPasscode()
Boolean	getResetLockout()
boolean	resetLockoutFlagExist()
UserCommunicationBarringUserControl.UserCommunicationBarringUserControlModifyRequest	setEnableProfile(Integer enableProfile)
UserCommunicationBarringUserControl.UserCommunicationBarringUserControlModifyRequest	setFlagResetLockout()
UserCommunicationBarringUserControl.UserCommunicationBarringUserControlModifyRequest	setNewPasscode(String newPasscode)
UserCommunicationBarringUserControl.UserCommunicationBarringUserControlModifyRequest	setOldPasscode(String oldPasscode)
UserCommunicationBarringUserControl.UserCommunicationBarringUserControlModifyRequest	setUser(BroadWorksUser user)
UserCommunicationBarringUserControl.UserCommunicationBarringUserControlModifyRequest	unsetEnableProfile()

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

enableProfile

protected Optional<Integer> enableProfile

oldPasscode

@Size(min=1,
      max=30)
protected @Size(min=1,max=30) String oldPasscode

newPasscode

@Size(min=1,
      max=30)
protected @Size(min=1,max=30) String newPasscode

resetLockout

@AssertTrue
protected @AssertTrue Boolean resetLockout

Constructor Details

UserCommunicationBarringUserControlModifyRequest

public UserCommunicationBarringUserControlModifyRequest()

UserCommunicationBarringUserControlModifyRequest

public UserCommunicationBarringUserControlModifyRequest(BroadWorksUser user)

Method Details

setUser

public UserCommunicationBarringUserControl.UserCommunicationBarringUserControlModifyRequest setUser(BroadWorksUser user)

getBroadWorksUser

public BroadWorksUser getBroadWorksUser()

unsetEnableProfile

public UserCommunicationBarringUserControl.UserCommunicationBarringUserControlModifyRequest unsetEnableProfile()

setEnableProfile

public UserCommunicationBarringUserControl.UserCommunicationBarringUserControlModifyRequest setEnableProfile(Integer enableProfile)

getEnableProfile

public Optional<Integer> getEnableProfile()

setOldPasscode

public UserCommunicationBarringUserControl.UserCommunicationBarringUserControlModifyRequest setOldPasscode(String oldPasscode)

getOldPasscode

public String getOldPasscode()

setNewPasscode

public UserCommunicationBarringUserControl.UserCommunicationBarringUserControlModifyRequest setNewPasscode(String newPasscode)

getNewPasscode

public String getNewPasscode()

setFlagResetLockout

public UserCommunicationBarringUserControl.UserCommunicationBarringUserControlModifyRequest setFlagResetLockout()

resetLockoutFlagExist

public boolean resetLockoutFlagExist()

getResetLockout

public Boolean getResetLockout()

getEmptyObject

public static UserCommunicationBarringUserControl.UserCommunicationBarringUserControlModifyRequest 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<DefaultResponse>