Package co.ecg.alpaca.toolkit.generated

Class Group.GroupScheduleModifyEventRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.Group.GroupScheduleModifyEventRequest

Enclosing class:

Group

@Choice(minOccurs=0,value={@ChoiceGroup("allDayEvent"),@ChoiceGroup({"startTime","endTime"})})
public static class Group.GroupScheduleModifyEventRequest
extends Request<DefaultResponse>

Modify an event of a group 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 LocalDate	endDate
protected @Valid HourMinute	endTime
protected @NotNull @Size(min=1,max=40) String	eventName
protected @NotNull @Valid Group	group
protected @Size(min=1,max=40) String	newEventName
protected Optional<@Valid Recurrence>	recurrence
protected @NotNull @Valid ScheduleKey	scheduleKey
protected LocalDate	startDate
protected @Valid HourMinute	startTime

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

log

Constructor Summary

Constructors

Constructor	Description
GroupScheduleModifyEventRequest()
GroupScheduleModifyEventRequest(Group group, ScheduleKey scheduleKey, String eventName)

Method Summary

Modifier and Type	Method	Description
boolean	allDayEventFlagExist()
void	formRequest()	Forms the XML Document for this Request Object.
Boolean	getAllDayEvent()
static Group.GroupScheduleModifyEventRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
LocalDate	getEndDate()
HourMinute	getEndTime()
String	getEventName()
Group	getGroup()
String	getNewEventName()
Optional<@Valid Recurrence>	getRecurrence()
ScheduleKey	getScheduleKey()
LocalDate	getStartDate()
HourMinute	getStartTime()
Group.GroupScheduleModifyEventRequest	setEndDate(LocalDate endDate)
Group.GroupScheduleModifyEventRequest	setEndTime(HourMinute endTime)
Group.GroupScheduleModifyEventRequest	setEventName(String eventName)
Group.GroupScheduleModifyEventRequest	setFlagAllDayEvent()
Group.GroupScheduleModifyEventRequest	setGroup(Group group)
Group.GroupScheduleModifyEventRequest	setNewEventName(String newEventName)
Group.GroupScheduleModifyEventRequest	setRecurrence(Recurrence recurrence)
Group.GroupScheduleModifyEventRequest	setScheduleKey(ScheduleKey scheduleKey)
Group.GroupScheduleModifyEventRequest	setStartDate(LocalDate startDate)
Group.GroupScheduleModifyEventRequest	setStartTime(HourMinute startTime)
Group.GroupScheduleModifyEventRequest	unsetRecurrence()

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

group

@NotNull
@Valid
protected transient @NotNull @Valid Group group

scheduleKey

@NotNull
@Valid
protected @NotNull @Valid ScheduleKey scheduleKey

eventName

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

newEventName

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

startDate

protected LocalDate startDate

allDayEvent

@AssertTrue
protected @AssertTrue Boolean allDayEvent

startTime

@Valid
protected @Valid HourMinute startTime

endTime

@Valid
protected @Valid HourMinute endTime

endDate

protected LocalDate endDate

recurrence

protected Optional<@Valid Recurrence> recurrence

Constructor Detail

GroupScheduleModifyEventRequest

public GroupScheduleModifyEventRequest()

GroupScheduleModifyEventRequest

public GroupScheduleModifyEventRequest(Group group,
                                       ScheduleKey scheduleKey,
                                       String eventName)

Method Detail

setGroup

public Group.GroupScheduleModifyEventRequest setGroup(Group group)

getGroup

public Group getGroup()

setScheduleKey

public Group.GroupScheduleModifyEventRequest setScheduleKey(ScheduleKey scheduleKey)

getScheduleKey

public ScheduleKey getScheduleKey()

setEventName

public Group.GroupScheduleModifyEventRequest setEventName(String eventName)

getEventName

public String getEventName()

setNewEventName

public Group.GroupScheduleModifyEventRequest setNewEventName(String newEventName)

getNewEventName

public String getNewEventName()

setStartDate

public Group.GroupScheduleModifyEventRequest setStartDate(LocalDate startDate)

getStartDate

public LocalDate getStartDate()

setFlagAllDayEvent

public Group.GroupScheduleModifyEventRequest setFlagAllDayEvent()

allDayEventFlagExist

public boolean allDayEventFlagExist()

getAllDayEvent

public Boolean getAllDayEvent()

setStartTime

public Group.GroupScheduleModifyEventRequest setStartTime(HourMinute startTime)

getStartTime

public HourMinute getStartTime()

setEndTime

public Group.GroupScheduleModifyEventRequest setEndTime(HourMinute endTime)

getEndTime

public HourMinute getEndTime()

setEndDate

public Group.GroupScheduleModifyEventRequest setEndDate(LocalDate endDate)

getEndDate

public LocalDate getEndDate()

unsetRecurrence

public Group.GroupScheduleModifyEventRequest unsetRecurrence()

setRecurrence

public Group.GroupScheduleModifyEventRequest setRecurrence(Recurrence recurrence)

getRecurrence

public Optional<@Valid Recurrence> getRecurrence()

getEmptyObject

public static Group.GroupScheduleModifyEventRequest 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>