co.ecg.alpaca.toolkit.generated

Class BWSystem.SystemScheduleModifyEventRequest

java.lang.Object

co.ecg.alpaca.toolkit.Request<Response.DefaultResponse>

co.ecg.alpaca.toolkit.generated.BWSystem.SystemScheduleModifyEventRequest

All Implemented Interfaces:

Runnable

Enclosing class:

BWSystem

public static class BWSystem.SystemScheduleModifyEventRequest
extends Request<Response.DefaultResponse>

Modify an event of a 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.

Field Summary

Fields

Modifier and Type	Field and Description
Boolean	allDayEvent
boolean	allDayEventIsModified
Date	endDate
boolean	endDateIsModified
HourMinute	endTime
boolean	endTimeIsModified
String	eventName
boolean	eventNameIsModified
String	newEventName
boolean	newEventNameIsModified
Recurrence	recurrence
boolean	recurrenceIsModified
ScheduleKey	scheduleKey
boolean	scheduleKeyIsModified
Date	startDate
boolean	startDateIsModified
HourMinute	startTime
boolean	startTimeIsModified

Constructor Summary

Constructors

Constructor and Description
SystemScheduleModifyEventRequest(BroadWorksServer bws) Default Constructor -- Not Guaranteed to work without checking Request validity with isValid()
SystemScheduleModifyEventRequest(BroadWorksServer bws, ScheduleKey scheduleKey, String eventName)

Method Summary

Modifier and Type	Method and Description
void	formRequest() Forms the XML Document for this Request Object.
Boolean	getAllDayEvent()
Date	getEndDate()
HourMinute	getEndTime()
String	getEventName()
String	getNewEventName()
Recurrence	getRecurrence()
ScheduleKey	getScheduleKey()
Date	getStartDate()
HourMinute	getStartTime()
BWSystem.SystemScheduleModifyEventRequest	setAllDayEvent(Boolean allDayEvent)
BWSystem.SystemScheduleModifyEventRequest	setEndDate(Date endDate)
BWSystem.SystemScheduleModifyEventRequest	setEndTime(HourMinute endTime)
BWSystem.SystemScheduleModifyEventRequest	setEventName(String eventName)
BWSystem.SystemScheduleModifyEventRequest	setNewEventName(String newEventName)
BWSystem.SystemScheduleModifyEventRequest	setRecurrence(Recurrence recurrence)
BWSystem.SystemScheduleModifyEventRequest	setScheduleKey(ScheduleKey scheduleKey)
BWSystem.SystemScheduleModifyEventRequest	setStartDate(Date startDate)
BWSystem.SystemScheduleModifyEventRequest	setStartTime(HourMinute startTime)

Methods inherited from class co.ecg.alpaca.toolkit.Request

appendChild, appendChild, appendChild, asyncFire, createElement, createNilElement, createTextElement, fire, fire, getBroadWorksServer, getCommandType, getDomDocument, getResponseClass, isMemberOfBundle, isValid, run, setBroadWorksServer, setCommandElement, setCommandType, setDomDocument, setMemberOfBundle, setRequestId, setResponseClass, setRootElement, toString, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

scheduleKey

@NotNull
public ScheduleKey scheduleKey

scheduleKeyIsModified

public transient boolean scheduleKeyIsModified

eventName

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

eventNameIsModified

public transient boolean eventNameIsModified

newEventName

@Size(min=1,
      max=40)
public String newEventName

newEventNameIsModified

public transient boolean newEventNameIsModified

startDate

public Date startDate

startDateIsModified

public transient boolean startDateIsModified

allDayEvent

@AssertTrue
public Boolean allDayEvent

allDayEventIsModified

public transient boolean allDayEventIsModified

startTime

public HourMinute startTime

startTimeIsModified

public transient boolean startTimeIsModified

endTime

public HourMinute endTime

endTimeIsModified

public transient boolean endTimeIsModified

endDate

public Date endDate

endDateIsModified

public transient boolean endDateIsModified

recurrence

public Recurrence recurrence

recurrenceIsModified

public transient boolean recurrenceIsModified

Constructor Detail

SystemScheduleModifyEventRequest

public SystemScheduleModifyEventRequest(BroadWorksServer bws,
                                        ScheduleKey scheduleKey,
                                        String eventName)

SystemScheduleModifyEventRequest

public SystemScheduleModifyEventRequest(BroadWorksServer bws)

Default Constructor -- Not Guaranteed to work without checking Request validity with isValid()

Parameters:

bws - The BroadWorksServer to use for the Request

Method Detail

setScheduleKey

public BWSystem.SystemScheduleModifyEventRequest setScheduleKey(ScheduleKey scheduleKey)

getScheduleKey

public ScheduleKey getScheduleKey()

setEventName

public BWSystem.SystemScheduleModifyEventRequest setEventName(String eventName)

getEventName

public String getEventName()

setNewEventName

public BWSystem.SystemScheduleModifyEventRequest setNewEventName(String newEventName)

getNewEventName

public String getNewEventName()

setStartDate

public BWSystem.SystemScheduleModifyEventRequest setStartDate(Date startDate)

getStartDate

public Date getStartDate()

setAllDayEvent

public BWSystem.SystemScheduleModifyEventRequest setAllDayEvent(Boolean allDayEvent)

getAllDayEvent

public Boolean getAllDayEvent()

setStartTime

public BWSystem.SystemScheduleModifyEventRequest setStartTime(HourMinute startTime)

getStartTime

public HourMinute getStartTime()

setEndTime

public BWSystem.SystemScheduleModifyEventRequest setEndTime(HourMinute endTime)

getEndTime

public HourMinute getEndTime()

setEndDate

public BWSystem.SystemScheduleModifyEventRequest setEndDate(Date endDate)

getEndDate

public Date getEndDate()

setRecurrence

public BWSystem.SystemScheduleModifyEventRequest setRecurrence(Recurrence recurrence)

getRecurrence

public Recurrence getRecurrence()

formRequest

public void formRequest()
                 throws RequestException

Forms the XML Document for this Request Object. Called by the Request upon fire().

Specified by:

formRequest in class Request<Response.DefaultResponse>

Throws:

RequestException