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

Class UserSeriesCompletion.UserSeriesCompletionGetRequest

java.lang.Object

co.ecg.alpaca.toolkit.messaging.request.Request<UserSeriesCompletion.UserSeriesCompletionGetResponse>

co.ecg.alpaca.toolkit.generated.services.UserSeriesCompletion.UserSeriesCompletionGetRequest

Enclosing class:

UserSeriesCompletion

public static class UserSeriesCompletion.UserSeriesCompletionGetRequest
extends Request<UserSeriesCompletion.UserSeriesCompletionGetResponse>

Gets the details of the Series Completion group that a user belongs to (if any). Any user can only belong to one Series Completion group. The response is either UserSeriesCompletionGetResponse 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
UserSeriesCompletionGetRequest()
UserSeriesCompletionGetRequest(BroadWorksUser user)

Method Summary

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

UserSeriesCompletionGetRequest

public UserSeriesCompletionGetRequest()

UserSeriesCompletionGetRequest

public UserSeriesCompletionGetRequest(BroadWorksUser user)

Method Details

setUser

public UserSeriesCompletion.UserSeriesCompletionGetRequest setUser(BroadWorksUser user)

getBroadWorksUser

public BroadWorksUser getBroadWorksUser()

getEmptyObject

public static UserSeriesCompletion.UserSeriesCompletionGetRequest 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<UserSeriesCompletion.UserSeriesCompletionGetResponse>