Package co.ecg.alpaca.toolkit.generated

Class Login.PasswordModifyRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.Login.PasswordModifyRequest

Enclosing class:

Login

public static class Login.PasswordModifyRequest
extends Request<DefaultResponse>

Modify the password for a user/administrator. When oldPassword is specified, password rule applies. If oldPassword in not specified, any password rule related to old password does not apply. 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=60) String	newPassword
protected @Size(min=1,max=60) String	oldPassword
protected @NotNull @Size(min=1,max=161) String	userId

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

log

Constructor Summary

Constructors

Constructor	Description
PasswordModifyRequest()
PasswordModifyRequest(BroadWorksServer broadWorksServer, String userId, String newPassword)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
static Login.PasswordModifyRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
String	getNewPassword()
String	getOldPassword()
String	getUserId()
Login.PasswordModifyRequest	setNewPassword(String newPassword)
Login.PasswordModifyRequest	setOldPassword(String oldPassword)
Login.PasswordModifyRequest	setUserId(String userId)

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

userId

@NotNull
@Size(min=1,
      max=161)
protected @NotNull @Size(min=1,max=161) String userId

oldPassword

@Size(min=1,
      max=60)
protected @Size(min=1,max=60) String oldPassword

newPassword

@NotNull
@Size(min=1,
      max=60)
protected @NotNull @Size(min=1,max=60) String newPassword

Constructor Details

PasswordModifyRequest

public PasswordModifyRequest()

PasswordModifyRequest

public PasswordModifyRequest(BroadWorksServer broadWorksServer,
 String userId,
 String newPassword)

Method Details

setUserId

public Login.PasswordModifyRequest setUserId(String userId)

getUserId

public String getUserId()

setOldPassword

public Login.PasswordModifyRequest setOldPassword(String oldPassword)

getOldPassword

public String getOldPassword()

setNewPassword

public Login.PasswordModifyRequest setNewPassword(String newPassword)

getNewPassword

public String getNewPassword()

getEmptyObject

public static Login.PasswordModifyRequest 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>