Package co.ecg.alpaca.toolkit.generated

Class User.UserAlternateUserIdModifyRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.User.UserAlternateUserIdModifyRequest

Enclosing class:

User

public static class User.UserAlternateUserIdModifyRequest
extends Request<DefaultResponse>

Request to modify an alternate user id of a user. 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 @NotNull @Size(min=1,max=161) java.lang.String	alternateUserId
protected java.util.Optional<@Size(min=1,max=80) java.lang.String>	description
protected @Size(min=1,max=161) java.lang.String	newAlternateUserId
protected @NotNull @Valid BroadWorksUser	user

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

log

Constructor Summary

Constructors

Constructor	Description
UserAlternateUserIdModifyRequest()
UserAlternateUserIdModifyRequest(BroadWorksUser user, java.lang.String alternateUserId)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
java.lang.String	getAlternateUserId()
BroadWorksUser	getBroadWorksUser()
java.util.Optional<@Size(min=1,max=80) java.lang.String>	getDescription()
static User.UserAlternateUserIdModifyRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
java.lang.String	getNewAlternateUserId()
User.UserAlternateUserIdModifyRequest	setAlternateUserId(java.lang.String alternateUserId)
User.UserAlternateUserIdModifyRequest	setDescription(java.lang.String description)
User.UserAlternateUserIdModifyRequest	setNewAlternateUserId(java.lang.String newAlternateUserId)
User.UserAlternateUserIdModifyRequest	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, isMemberOfBundle, isValid, setBroadWorksServer, setCommandElement, setCommandType, setDomDocument, setEcho, 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

alternateUserId

@NotNull @Size(min=1, max=161) protected @NotNull @Size(min=1,max=161) java.lang.String alternateUserId

newAlternateUserId

@Size(min=1, max=161) protected @Size(min=1,max=161) java.lang.String newAlternateUserId

description

protected java.util.Optional<@Size(min=1,max=80) java.lang.String> description

Constructor Details

UserAlternateUserIdModifyRequest

public UserAlternateUserIdModifyRequest()

UserAlternateUserIdModifyRequest

public UserAlternateUserIdModifyRequest(BroadWorksUser user, java.lang.String alternateUserId)

Method Details

setUser

public User.UserAlternateUserIdModifyRequest setUser(BroadWorksUser user)

getBroadWorksUser

public BroadWorksUser getBroadWorksUser()

setAlternateUserId

public User.UserAlternateUserIdModifyRequest setAlternateUserId(java.lang.String alternateUserId)

getAlternateUserId

public java.lang.String getAlternateUserId()

setNewAlternateUserId

public User.UserAlternateUserIdModifyRequest setNewAlternateUserId(java.lang.String newAlternateUserId)

getNewAlternateUserId

public java.lang.String getNewAlternateUserId()

setDescription

public User.UserAlternateUserIdModifyRequest setDescription(java.lang.String description)

getDescription

public java.util.Optional<@Size(min=1,max=80) java.lang.String> getDescription()

getEmptyObject

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