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

Class UserCommunicator.UserBroadWorksCommunicatorGetRequest

java.lang.Object

co.ecg.alpaca.toolkit.messaging.request.Request<UserCommunicator.UserBroadWorksCommunicatorGetResponse>

co.ecg.alpaca.toolkit.generated.services.UserCommunicator.UserBroadWorksCommunicatorGetRequest

Enclosing class:

UserCommunicator

public static class UserCommunicator.UserBroadWorksCommunicatorGetRequest
extends Request<UserCommunicator.UserBroadWorksCommunicatorGetResponse>

Request to get the Configuration Server for a specified user. The response is either a UserBroadWorksCommunicatorGetResponse 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
UserBroadWorksCommunicatorGetRequest()
UserBroadWorksCommunicatorGetRequest(BroadWorksUser user)

Method Summary

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

user

@NotNull
@Valid
protected transient @NotNull @Valid BroadWorksUser user

Constructor Detail

UserBroadWorksCommunicatorGetRequest

public UserBroadWorksCommunicatorGetRequest()

UserBroadWorksCommunicatorGetRequest

public UserBroadWorksCommunicatorGetRequest(BroadWorksUser user)

Method Detail

setUser

public UserCommunicator.UserBroadWorksCommunicatorGetRequest setUser(BroadWorksUser user)

getBroadWorksUser

public BroadWorksUser getBroadWorksUser()

getEmptyObject

public static UserCommunicator.UserBroadWorksCommunicatorGetRequest 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<UserCommunicator.UserBroadWorksCommunicatorGetResponse>