Package co.ecg.alpaca.toolkit.generated

Class BWSystem.SystemScheduleAddEventRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.BWSystem.SystemScheduleAddEventRequest

Enclosing class:

BWSystem

@ChoiceGroup("allDayEvent") @ChoiceGroup({"startTime","endTime"})
public static class BWSystem.SystemScheduleAddEventRequest
extends Request<DefaultResponse>

Add an event to system schedule. The response is either a SuccessResponse or an ErrorResponse. The startDate element is adjusted to the first occurrence of the recurrent schedule that comes at or after the startDate. The endDate element is set to the sum of the adjusted starDate element value and the event duration.

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 @AssertTrue Boolean	allDayEvent
protected @NotNull LocalDate	endDate
protected @Valid HourMinute	endTime
protected @NotNull @Size(min=1,max=40) String	eventName
protected @Valid Recurrence	recurrence
protected @NotNull @Valid ScheduleKey	scheduleKey
protected @NotNull LocalDate	startDate
protected @Valid HourMinute	startTime

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

log

Constructor Summary

Constructors

Constructor	Description
SystemScheduleAddEventRequest()
SystemScheduleAddEventRequest(BroadWorksServer broadWorksServer, HourMinute startTime, HourMinute endTime, ScheduleKey scheduleKey, String eventName, LocalDate startDate, LocalDate endDate)
SystemScheduleAddEventRequest(BroadWorksServer broadWorksServer, ScheduleKey scheduleKey, String eventName, LocalDate startDate, LocalDate endDate)
SystemScheduleAddEventRequest(BroadWorksServer broadWorksServer, Boolean allDayEvent, ScheduleKey scheduleKey, String eventName, LocalDate startDate, LocalDate endDate)

Method Summary

Modifier and Type	Method	Description
boolean	allDayEventFlagExist()
void	formRequest()	Forms the XML Document for this Request Object.
Boolean	getAllDayEvent()
static BWSystem.SystemScheduleAddEventRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
LocalDate	getEndDate()
HourMinute	getEndTime()
String	getEventName()
Recurrence	getRecurrence()
ScheduleKey	getScheduleKey()
LocalDate	getStartDate()
HourMinute	getStartTime()
BWSystem.SystemScheduleAddEventRequest	setEndDate(LocalDate endDate)
BWSystem.SystemScheduleAddEventRequest	setEndTime(HourMinute endTime)
BWSystem.SystemScheduleAddEventRequest	setEventName(String eventName)
BWSystem.SystemScheduleAddEventRequest	setFlagAllDayEvent()
BWSystem.SystemScheduleAddEventRequest	setRecurrence(Recurrence recurrence)
BWSystem.SystemScheduleAddEventRequest	setScheduleKey(ScheduleKey scheduleKey)
BWSystem.SystemScheduleAddEventRequest	setStartDate(LocalDate startDate)
BWSystem.SystemScheduleAddEventRequest	setStartTime(HourMinute startTime)

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

eventName

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

startDate

@NotNull
protected @NotNull LocalDate startDate

allDayEvent

@AssertTrue
protected @AssertTrue Boolean allDayEvent

startTime

@Valid
protected @Valid HourMinute startTime

endTime

@Valid
protected @Valid HourMinute endTime

endDate

@NotNull
protected @NotNull LocalDate endDate

recurrence

@Valid
protected @Valid Recurrence recurrence

Constructor Details

SystemScheduleAddEventRequest

public SystemScheduleAddEventRequest()

SystemScheduleAddEventRequest

public SystemScheduleAddEventRequest(BroadWorksServer broadWorksServer,
 ScheduleKey scheduleKey,
 String eventName,
 LocalDate startDate,
 LocalDate endDate)

SystemScheduleAddEventRequest

public SystemScheduleAddEventRequest(BroadWorksServer broadWorksServer,
 Boolean allDayEvent,
 ScheduleKey scheduleKey,
 String eventName,
 LocalDate startDate,
 LocalDate endDate)

SystemScheduleAddEventRequest

public SystemScheduleAddEventRequest(BroadWorksServer broadWorksServer,
 HourMinute startTime,
 HourMinute endTime,
 ScheduleKey scheduleKey,
 String eventName,
 LocalDate startDate,
 LocalDate endDate)

Method Details

setScheduleKey

public BWSystem.SystemScheduleAddEventRequest setScheduleKey(ScheduleKey scheduleKey)

getScheduleKey

public ScheduleKey getScheduleKey()

setEventName

public BWSystem.SystemScheduleAddEventRequest setEventName(String eventName)

getEventName

public String getEventName()

setStartDate

public BWSystem.SystemScheduleAddEventRequest setStartDate(LocalDate startDate)

getStartDate

public LocalDate getStartDate()

setFlagAllDayEvent

public BWSystem.SystemScheduleAddEventRequest setFlagAllDayEvent()

allDayEventFlagExist

public boolean allDayEventFlagExist()

getAllDayEvent

public Boolean getAllDayEvent()

setStartTime

public BWSystem.SystemScheduleAddEventRequest setStartTime(HourMinute startTime)

getStartTime

public HourMinute getStartTime()

setEndTime

public BWSystem.SystemScheduleAddEventRequest setEndTime(HourMinute endTime)

getEndTime

public HourMinute getEndTime()

setEndDate

public BWSystem.SystemScheduleAddEventRequest setEndDate(LocalDate endDate)

getEndDate

public LocalDate getEndDate()

setRecurrence

public BWSystem.SystemScheduleAddEventRequest setRecurrence(Recurrence recurrence)

getRecurrence

public Recurrence getRecurrence()

getEmptyObject

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