Package co.ecg.alpaca.toolkit.generated

Class Login.TutorialFlagModifyRequest

java.lang.Object

co.ecg.alpaca.toolkit.messaging.request.Request<DefaultResponse>

co.ecg.alpaca.toolkit.generated.Login.TutorialFlagModifyRequest

Enclosing class:

Login

public static class Login.TutorialFlagModifyRequest
extends Request<DefaultResponse>

Modify the tutorial flag setting for a user or admin. The response is either a SuccessResponse 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 Boolean	enableTutorial
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
TutorialFlagModifyRequest()
TutorialFlagModifyRequest(BroadWorksServer broadWorksServer, String userId)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
static Login.TutorialFlagModifyRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
Boolean	getEnableTutorial()
String	getUserId()
Login.TutorialFlagModifyRequest	setEnableTutorial(Boolean enableTutorial)
Login.TutorialFlagModifyRequest	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

enableTutorial

protected Boolean enableTutorial

Constructor Details

TutorialFlagModifyRequest

public TutorialFlagModifyRequest()

TutorialFlagModifyRequest

public TutorialFlagModifyRequest(BroadWorksServer broadWorksServer,
 String userId)

Method Details

setUserId

public Login.TutorialFlagModifyRequest setUserId(String userId)

getUserId

public String getUserId()

setEnableTutorial

public Login.TutorialFlagModifyRequest setEnableTutorial(Boolean enableTutorial)

getEnableTutorial

public Boolean getEnableTutorial()

getEmptyObject

public static Login.TutorialFlagModifyRequest 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<DefaultResponse>