Package co.ecg.alpaca.toolkit.generated

Class BWSystem.SystemScheduleModifyRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.BWSystem.SystemScheduleModifyRequest

Enclosing class:

BWSystem

public static class BWSystem.SystemScheduleModifyRequest
extends Request<DefaultResponse>

Modify a system schedule. 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 @Size(min=1,max=40) String	newScheduleName
protected @NotNull @Valid ScheduleKey	scheduleKey

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

log

Constructor Summary

Constructors

Constructor	Description
SystemScheduleModifyRequest()
SystemScheduleModifyRequest(BroadWorksServer broadWorksServer, ScheduleKey scheduleKey)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
static BWSystem.SystemScheduleModifyRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
String	getNewScheduleName()
ScheduleKey	getScheduleKey()
BWSystem.SystemScheduleModifyRequest	setNewScheduleName(String newScheduleName)
BWSystem.SystemScheduleModifyRequest	setScheduleKey(ScheduleKey scheduleKey)

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, isMemberOfBundle, isValid, setBroadWorksServer, setCommandElement, setCommandType, setDomDocument, setEcho, 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

scheduleKey

@NotNull
@Valid
protected @NotNull @Valid ScheduleKey scheduleKey

newScheduleName

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

Constructor Detail

SystemScheduleModifyRequest

public SystemScheduleModifyRequest()

SystemScheduleModifyRequest

public SystemScheduleModifyRequest(BroadWorksServer broadWorksServer,
                                   ScheduleKey scheduleKey)

Method Detail

setScheduleKey

public BWSystem.SystemScheduleModifyRequest setScheduleKey(ScheduleKey scheduleKey)

getScheduleKey

public ScheduleKey getScheduleKey()

setNewScheduleName

public BWSystem.SystemScheduleModifyRequest setNewScheduleName(String newScheduleName)

getNewScheduleName

public String getNewScheduleName()

getEmptyObject

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