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

Class UserDirectRoute.UserDirectRouteGetRequest

java.lang.Object

co.ecg.alpaca.toolkit.messaging.request.Request<UserDirectRoute.UserDirectRouteGetResponse>

co.ecg.alpaca.toolkit.generated.services.UserDirectRoute.UserDirectRouteGetRequest

Enclosing class:

UserDirectRoute

public static class UserDirectRoute.UserDirectRouteGetRequest
extends Request<UserDirectRoute.UserDirectRouteGetResponse>

Get the direct route setting and the list of DTGs/Trunk Identities assigned to a user. The response is either UserDirectRouteGetResponse 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 @Valid BroadWorksUser	user

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

log

Constructor Summary

Constructors

Constructor	Description
UserDirectRouteGetRequest()
UserDirectRouteGetRequest(BroadWorksUser user)

Method Summary

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

UserDirectRouteGetRequest

public UserDirectRouteGetRequest()

UserDirectRouteGetRequest

public UserDirectRouteGetRequest(BroadWorksUser user)

Method Details

setUser

public UserDirectRoute.UserDirectRouteGetRequest setUser(BroadWorksUser user)

getBroadWorksUser

public BroadWorksUser getBroadWorksUser()

getEmptyObject

public static UserDirectRoute.UserDirectRouteGetRequest 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<UserDirectRoute.UserDirectRouteGetResponse>