Package co.ecg.alpaca.toolkit.generated

Class User.UserPortalPasscodeModifyRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.User.UserPortalPasscodeModifyRequest

Enclosing class:

User

public static class User.UserPortalPasscodeModifyRequest
extends Request<DefaultResponse>

Modify the user's Portal passcode The response is either a SuccessResponse or an ErrorResponse. The following elements are only used in XS data mode and ignored in AS data mode: oldPasscode

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=30) String	newPasscode
protected @Size(min=1,max=30) String	oldPasscode
protected @NotNull @Valid BroadWorksUser	user

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

log

Constructor Summary

Constructors

Constructor	Description
UserPortalPasscodeModifyRequest()
UserPortalPasscodeModifyRequest(BroadWorksUser user, String newPasscode)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
BroadWorksUser	getBroadWorksUser()
static User.UserPortalPasscodeModifyRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
String	getNewPasscode()
String	getOldPasscode()
User.UserPortalPasscodeModifyRequest	setNewPasscode(String newPasscode)
User.UserPortalPasscodeModifyRequest	setOldPasscode(String oldPasscode)
User.UserPortalPasscodeModifyRequest	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

oldPasscode

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

newPasscode

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

Constructor Details

UserPortalPasscodeModifyRequest

public UserPortalPasscodeModifyRequest()

UserPortalPasscodeModifyRequest

public UserPortalPasscodeModifyRequest(BroadWorksUser user,
 String newPasscode)

Method Details

setUser

public User.UserPortalPasscodeModifyRequest setUser(BroadWorksUser user)

getBroadWorksUser

public BroadWorksUser getBroadWorksUser()

setOldPasscode

public User.UserPortalPasscodeModifyRequest setOldPasscode(String oldPasscode)

getOldPasscode

public String getOldPasscode()

setNewPasscode

public User.UserPortalPasscodeModifyRequest setNewPasscode(String newPasscode)

getNewPasscode

public String getNewPasscode()

getEmptyObject

public static User.UserPortalPasscodeModifyRequest 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>