Package co.ecg.alpaca.toolkit.generated

Class Login.TutorialFlagGetRequest

java.lang.Object

co.ecg.alpaca.toolkit.messaging.request.Request<Login.TutorialFlagGetResponse>

co.ecg.alpaca.toolkit.generated.Login.TutorialFlagGetRequest

Enclosing class:

Login

public static class Login.TutorialFlagGetRequest
extends Request<Login.TutorialFlagGetResponse>

Get the tutorial flag setting for a user or admin. The response is either a TutorialFlagGetResponse 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 @Size(min=1,max=161) String	userId

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

log

Constructor Summary

Constructors

Constructor	Description
TutorialFlagGetRequest()
TutorialFlagGetRequest(BroadWorksServer broadWorksServer, String userId)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
static Login.TutorialFlagGetRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
String	getUserId()
Login.TutorialFlagGetRequest	setUserId(String userId)

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

userId

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

Constructor Details

TutorialFlagGetRequest

public TutorialFlagGetRequest()

TutorialFlagGetRequest

public TutorialFlagGetRequest(BroadWorksServer broadWorksServer,
 String userId)

Method Details

setUserId

public Login.TutorialFlagGetRequest setUserId(String userId)

getUserId

public String getUserId()

getEmptyObject

public static Login.TutorialFlagGetRequest 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<Login.TutorialFlagGetResponse>