Package co.ecg.alpaca.toolkit.generated

Class BWSystem.SystemXsiApplicationIdModifyRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.BWSystem.SystemXsiApplicationIdModifyRequest

Enclosing class:

BWSystem

public static class BWSystem.SystemXsiApplicationIdModifyRequest
extends Request<DefaultResponse>

Modify the system Xsi applicaiton Id description. 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 Optional<@Size(min=1,max=80) String>	description
protected @NotNull @Size(min=1,max=256) String	xsiApplicationId

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

log

Constructor Summary

Constructors

Constructor	Description
SystemXsiApplicationIdModifyRequest()
SystemXsiApplicationIdModifyRequest(BroadWorksServer broadWorksServer, String xsiApplicationId)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
Optional<@Size(min=1,max=80) String>	getDescription()
static BWSystem.SystemXsiApplicationIdModifyRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
String	getXsiApplicationId()
BWSystem.SystemXsiApplicationIdModifyRequest	setDescription(String description)
BWSystem.SystemXsiApplicationIdModifyRequest	setXsiApplicationId(String xsiApplicationId)
BWSystem.SystemXsiApplicationIdModifyRequest	unsetDescription()

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

xsiApplicationId

@NotNull
@Size(min=1,
      max=256)
protected @NotNull @Size(min=1,max=256) String xsiApplicationId

description

protected Optional<@Size(min=1,max=80) String> description

Constructor Details

SystemXsiApplicationIdModifyRequest

public SystemXsiApplicationIdModifyRequest()

SystemXsiApplicationIdModifyRequest

public SystemXsiApplicationIdModifyRequest(BroadWorksServer broadWorksServer,
 String xsiApplicationId)

Method Details

setXsiApplicationId

public BWSystem.SystemXsiApplicationIdModifyRequest setXsiApplicationId(String xsiApplicationId)

getXsiApplicationId

public String getXsiApplicationId()

unsetDescription

public BWSystem.SystemXsiApplicationIdModifyRequest unsetDescription()

setDescription

public BWSystem.SystemXsiApplicationIdModifyRequest setDescription(String description)

getDescription

public Optional<@Size(min=1,max=80) String> getDescription()

getEmptyObject

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