co.ecg.alpaca.toolkit.generated.services

Class CommunicationBarringUserControl.UserCommunicationBarringUserControlModifyRequest

java.lang.Object

co.ecg.alpaca.toolkit.Request<Response.DefaultResponse>

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

All Implemented Interfaces:

Runnable

Enclosing class:

CommunicationBarringUserControl

public static class CommunicationBarringUserControl.UserCommunicationBarringUserControlModifyRequest
extends Request<Response.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.

Field Summary

Fields

Modifier and Type	Field and Description
Integer	enableProfile
boolean	enableProfileIsModified
String	newPasscode
boolean	newPasscodeIsModified
String	oldPasscode
boolean	oldPasscodeIsModified
Boolean	resetLockout
boolean	resetLockoutIsModified
User	user
boolean	userIsModified

Constructor Summary

Constructors

Constructor and Description
UserCommunicationBarringUserControlModifyRequest(BroadWorksServer bws) Default Constructor -- Not Guaranteed to work without checking Request validity with isValid()
UserCommunicationBarringUserControlModifyRequest(User user)

Method Summary

Modifier and Type	Method and Description
void	formRequest() Forms the XML Document for this Request Object.
Integer	getEnableProfile()
String	getNewPasscode()
String	getOldPasscode()
Boolean	getResetLockout()
User	getUser()
CommunicationBarringUserControl.UserCommunicationBarringUserControlModifyRequest	setEnableProfile(Integer enableProfile)
CommunicationBarringUserControl.UserCommunicationBarringUserControlModifyRequest	setNewPasscode(String newPasscode)
CommunicationBarringUserControl.UserCommunicationBarringUserControlModifyRequest	setOldPasscode(String oldPasscode)
CommunicationBarringUserControl.UserCommunicationBarringUserControlModifyRequest	setResetLockout(Boolean resetLockout)
CommunicationBarringUserControl.UserCommunicationBarringUserControlModifyRequest	setUser(User user)

Methods inherited from class co.ecg.alpaca.toolkit.Request

appendChild, appendChild, appendChild, asyncFire, createElement, createNilElement, createTextElement, fire, fire, getBroadWorksServer, getCommandType, getDomDocument, getResponseClass, isMemberOfBundle, isValid, run, setBroadWorksServer, setCommandElement, setCommandType, setDomDocument, setMemberOfBundle, setRequestId, setResponseClass, setRootElement, toString, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

user

@NotNull
public User user

userIsModified

public transient boolean userIsModified

enableProfile

public Integer enableProfile

enableProfileIsModified

public transient boolean enableProfileIsModified

oldPasscode

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

oldPasscodeIsModified

public transient boolean oldPasscodeIsModified

newPasscode

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

newPasscodeIsModified

public transient boolean newPasscodeIsModified

resetLockout

@AssertTrue
public Boolean resetLockout

resetLockoutIsModified

public transient boolean resetLockoutIsModified

Constructor Detail

UserCommunicationBarringUserControlModifyRequest

public UserCommunicationBarringUserControlModifyRequest(User user)

UserCommunicationBarringUserControlModifyRequest

public UserCommunicationBarringUserControlModifyRequest(BroadWorksServer bws)

Default Constructor -- Not Guaranteed to work without checking Request validity with isValid()

Parameters:

bws - The BroadWorksServer to use for the Request

Method Detail

setUser

public CommunicationBarringUserControl.UserCommunicationBarringUserControlModifyRequest setUser(User user)

getUser

public User getUser()

setEnableProfile

public CommunicationBarringUserControl.UserCommunicationBarringUserControlModifyRequest setEnableProfile(Integer enableProfile)

getEnableProfile

public Integer getEnableProfile()

setOldPasscode

public CommunicationBarringUserControl.UserCommunicationBarringUserControlModifyRequest setOldPasscode(String oldPasscode)

getOldPasscode

public String getOldPasscode()

setNewPasscode

public CommunicationBarringUserControl.UserCommunicationBarringUserControlModifyRequest setNewPasscode(String newPasscode)

getNewPasscode

public String getNewPasscode()

setResetLockout

public CommunicationBarringUserControl.UserCommunicationBarringUserControlModifyRequest setResetLockout(Boolean resetLockout)

getResetLockout

public Boolean getResetLockout()

formRequest

public void formRequest()
                 throws RequestException

Forms the XML Document for this Request Object. Called by the Request upon fire().

Specified by:

formRequest in class Request<Response.DefaultResponse>

Throws:

RequestException