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

All Implemented Interfaces:

Runnable

Enclosing class:

Login

@GwtIncompatible
public static class Login.LogoutRequest
extends Request<DefaultResponse>

AlpacaLibrary Auto-Generated Java File 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.

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 and Description
protected LogoutRequestReason	reason
protected String	userId

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

log

Constructor Summary

Constructors

Constructor and Description
LogoutRequest(BroadWorksServer broadWorksServer, String userId)

Method Summary

Modifier and Type	Method and 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, createDocument, createElement, createNilElement, createTextElement, fire, fire, getBroadWorksServer, getCommandElement, getCommandType, getDomDocument, getId, getResponseClass, getRootElement, isMemberOfBundle, isValid, run, setBroadWorksServer, setCommandElement, setCommandType, setDomDocument, setMemberOfBundle, setRequestId, setResponseClass, setRootElement, toString, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

userId

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

reason

protected LogoutRequestReason reason

Constructor Detail

LogoutRequest

public LogoutRequest(BroadWorksServer broadWorksServer,
                     String userId)

Method Detail

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>