Package co.ecg.alpaca.toolkit.generated

Class User.UserAlternateUserIdAddRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.User.UserAlternateUserIdAddRequest

Enclosing class:

User

public static class User.UserAlternateUserIdAddRequest
extends Request<DefaultResponse>

Request to add an alternate user Id to an 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) String	alternateUserId
protected @Size(min=1,max=80) String	description
protected @NotNull @Valid BroadWorksUser	user

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

log

Constructor Summary

Constructors

Constructor	Description
UserAlternateUserIdAddRequest()
UserAlternateUserIdAddRequest(BroadWorksUser user, String alternateUserId)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
String	getAlternateUserId()
BroadWorksUser	getBroadWorksUser()
String	getDescription()
static User.UserAlternateUserIdAddRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
User.UserAlternateUserIdAddRequest	setAlternateUserId(String alternateUserId)
User.UserAlternateUserIdAddRequest	setDescription(String description)
User.UserAlternateUserIdAddRequest	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

alternateUserId

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

description

@Size(min=1,
      max=80)
protected @Size(min=1,max=80) String description

Constructor Details

UserAlternateUserIdAddRequest

public UserAlternateUserIdAddRequest()

UserAlternateUserIdAddRequest

public UserAlternateUserIdAddRequest(BroadWorksUser user,
 String alternateUserId)

Method Details

setUser

public User.UserAlternateUserIdAddRequest setUser(BroadWorksUser user)

getBroadWorksUser

public BroadWorksUser getBroadWorksUser()

setAlternateUserId

public User.UserAlternateUserIdAddRequest setAlternateUserId(String alternateUserId)

getAlternateUserId

public String getAlternateUserId()

setDescription

public User.UserAlternateUserIdAddRequest setDescription(String description)

getDescription

public String getDescription()

getEmptyObject

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