Package co.ecg.alpaca.toolkit.generated.services

Class ClassMark.SystemClassmarkModifyRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.services.ClassMark.SystemClassmarkModifyRequest

Enclosing class:

ClassMark

public static class ClassMark.SystemClassmarkModifyRequest
extends Request<DefaultResponse>

Modify a Class Mark in 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=40) String	classmark
protected @Size(min=1,max=32) String	value
protected Optional<@Size(min=1,max=40) String>	webDisplayKey

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

log

Constructor Summary

Constructors

Constructor	Description
SystemClassmarkModifyRequest()
SystemClassmarkModifyRequest(BroadWorksServer broadWorksServer, String classmark)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
String	getClassmark()
static ClassMark.SystemClassmarkModifyRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
String	getValue()
Optional<@Size(min=1,max=40) String>	getWebDisplayKey()
ClassMark.SystemClassmarkModifyRequest	setClassmark(String classmark)
ClassMark.SystemClassmarkModifyRequest	setValue(String value)
ClassMark.SystemClassmarkModifyRequest	setWebDisplayKey(String webDisplayKey)
ClassMark.SystemClassmarkModifyRequest	unsetWebDisplayKey()

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 Detail

classmark

@NotNull
@Size(min=1,
      max=40)
protected @NotNull @Size(min=1,max=40) String classmark

value

@Size(min=1,
      max=32)
protected @Size(min=1,max=32) String value

webDisplayKey

protected Optional<@Size(min=1,max=40) String> webDisplayKey

Constructor Detail

SystemClassmarkModifyRequest

public SystemClassmarkModifyRequest()

SystemClassmarkModifyRequest

public SystemClassmarkModifyRequest(BroadWorksServer broadWorksServer,
                                    String classmark)

Method Detail

setClassmark

public ClassMark.SystemClassmarkModifyRequest setClassmark(String classmark)

getClassmark

public String getClassmark()

setValue

public ClassMark.SystemClassmarkModifyRequest setValue(String value)

getValue

public String getValue()

unsetWebDisplayKey

public ClassMark.SystemClassmarkModifyRequest unsetWebDisplayKey()

setWebDisplayKey

public ClassMark.SystemClassmarkModifyRequest setWebDisplayKey(String webDisplayKey)

getWebDisplayKey

public Optional<@Size(min=1,max=40) String> getWebDisplayKey()

getEmptyObject

public static ClassMark.SystemClassmarkModifyRequest 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>