Package co.ecg.alpaca.toolkit.generated

Class BWSystem.SystemClientIdentityAddRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.BWSystem.SystemClientIdentityAddRequest

Enclosing class:

BWSystem

public static class BWSystem.SystemClientIdentityAddRequest
extends Request<DefaultResponse>

Request to add a client identity entry to the list of client identities in the system. 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 @NotNull @Size(min=1,max=161) String	clientIdentity

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

log

Constructor Summary

Constructors

Constructor	Description
SystemClientIdentityAddRequest()
SystemClientIdentityAddRequest(BroadWorksServer broadWorksServer, String clientIdentity)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
String	getClientIdentity()
static BWSystem.SystemClientIdentityAddRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
BWSystem.SystemClientIdentityAddRequest	setClientIdentity(String clientIdentity)

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

clientIdentity

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

Constructor Details

SystemClientIdentityAddRequest

public SystemClientIdentityAddRequest()

SystemClientIdentityAddRequest

public SystemClientIdentityAddRequest(BroadWorksServer broadWorksServer,
 String clientIdentity)

Method Details

setClientIdentity

public BWSystem.SystemClientIdentityAddRequest setClientIdentity(String clientIdentity)

getClientIdentity

public String getClientIdentity()

getEmptyObject

public static BWSystem.SystemClientIdentityAddRequest 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>