Package co.ecg.alpaca.toolkit.generated

Class Login.LogoutRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.Login.LogoutRequest

Enclosing class:

Login

public static class Login.LogoutRequest
extends Request<DefaultResponse>

LogoutRequest is sent when an OCI user logs out or when connection is lost. This command can be sent either to the server, or to the client from OCS. Response is either SuccessResponse 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 LogoutRequestReason	reason
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
LogoutRequest()
LogoutRequest(BroadWorksServer broadWorksServer, String userId)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
static Login.LogoutRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
LogoutRequestReason	getReason()
String	getUserId()
Login.LogoutRequest	setReason(LogoutRequestReason reason)
Login.LogoutRequest	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

reason

protected LogoutRequestReason reason

Constructor Details

LogoutRequest

public LogoutRequest()

LogoutRequest

public LogoutRequest(BroadWorksServer broadWorksServer,
 String userId)

Method Details

setUserId

public Login.LogoutRequest setUserId(String userId)

getUserId

public String getUserId()

setReason

public Login.LogoutRequest setReason(LogoutRequestReason reason)

getReason

public LogoutRequestReason getReason()

getEmptyObject

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