Package co.ecg.alpaca.toolkit.generated

Class BWSystem.SystemScheduleGetEventListRequest

java.lang.Object

co.ecg.alpaca.toolkit.messaging.request.Request<BWSystem.SystemScheduleGetEventListResponse>

co.ecg.alpaca.toolkit.generated.BWSystem.SystemScheduleGetEventListRequest

Enclosing class:

BWSystem

public static class BWSystem.SystemScheduleGetEventListRequest
extends Request<BWSystem.SystemScheduleGetEventListResponse>

Get the list of events of a system schedule. The response is either a SystemScheduleGetResponse 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 @Valid ScheduleKey	scheduleKey

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

log

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
static BWSystem.SystemScheduleGetEventListRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
ScheduleKey	getScheduleKey()
BWSystem.SystemScheduleGetEventListRequest	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, 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

scheduleKey

@NotNull
@Valid
protected @NotNull @Valid ScheduleKey scheduleKey

Constructor Details

SystemScheduleGetEventListRequest

public SystemScheduleGetEventListRequest()

SystemScheduleGetEventListRequest

public SystemScheduleGetEventListRequest(BroadWorksServer broadWorksServer,
 ScheduleKey scheduleKey)

Method Details

setScheduleKey

public BWSystem.SystemScheduleGetEventListRequest setScheduleKey(ScheduleKey scheduleKey)

getScheduleKey

public ScheduleKey getScheduleKey()

getEmptyObject

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