Package co.ecg.alpaca.toolkit.generated.services

Class UserAuthentication.UserAuthenticationGetRequest

java.lang.Object

co.ecg.alpaca.toolkit.messaging.request.Request<UserAuthentication.UserAuthenticationGetResponse>

co.ecg.alpaca.toolkit.generated.services.UserAuthentication.UserAuthenticationGetRequest

Enclosing class:

UserAuthentication

public static class UserAuthentication.UserAuthenticationGetRequest
extends Request<UserAuthentication.UserAuthenticationGetResponse>

Get the user's authentication service information. The response is either a UserAuthenticationGetResponse 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 @Valid BroadWorksUser	user

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

log

Constructor Summary

Constructors

Constructor	Description
UserAuthenticationGetRequest()
UserAuthenticationGetRequest(BroadWorksUser user)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
BroadWorksUser	getBroadWorksUser()
static UserAuthentication.UserAuthenticationGetRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
UserAuthentication.UserAuthenticationGetRequest	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

Constructor Details

UserAuthenticationGetRequest

public UserAuthenticationGetRequest()

UserAuthenticationGetRequest

public UserAuthenticationGetRequest(BroadWorksUser user)

Method Details

setUser

public UserAuthentication.UserAuthenticationGetRequest setUser(BroadWorksUser user)

getBroadWorksUser

public BroadWorksUser getBroadWorksUser()

getEmptyObject

public static UserAuthentication.UserAuthenticationGetRequest 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<UserAuthentication.UserAuthenticationGetResponse>