Package co.ecg.alpaca.toolkit.generated

Class BWSystem.SystemScheduleAddRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.BWSystem.SystemScheduleAddRequest

Enclosing class:

BWSystem

public static class BWSystem.SystemScheduleAddRequest
extends Request<DefaultResponse>

Add 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 @NotNull @Size(min=1,max=40) String	scheduleName
protected @NotNull ScheduleType	scheduleType

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

log

Constructor Summary

Constructors

Constructor	Description
SystemScheduleAddRequest()
SystemScheduleAddRequest(BroadWorksServer broadWorksServer, String scheduleName, ScheduleType scheduleType)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
static BWSystem.SystemScheduleAddRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
String	getScheduleName()
ScheduleType	getScheduleType()
BWSystem.SystemScheduleAddRequest	setScheduleName(String scheduleName)
BWSystem.SystemScheduleAddRequest	setScheduleType(ScheduleType scheduleType)

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

scheduleName

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

scheduleType

@NotNull
protected @NotNull ScheduleType scheduleType

Constructor Detail

SystemScheduleAddRequest

public SystemScheduleAddRequest()

SystemScheduleAddRequest

public SystemScheduleAddRequest(BroadWorksServer broadWorksServer,
                                String scheduleName,
                                ScheduleType scheduleType)

Method Detail

setScheduleName

public BWSystem.SystemScheduleAddRequest setScheduleName(String scheduleName)

getScheduleName

public String getScheduleName()

setScheduleType

public BWSystem.SystemScheduleAddRequest setScheduleType(ScheduleType scheduleType)

getScheduleType

public ScheduleType getScheduleType()

getEmptyObject

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