Package co.ecg.alpaca.toolkit.generated

Class Group.GroupScheduleAddEventRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.Group.GroupScheduleAddEventRequest

Enclosing class:

Group

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

Add an event to 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 @NotNull LocalDate	endDate
protected @Valid HourMinute	endTime
protected @NotNull @Size(min=1,max=40) String	eventName
protected @NotNull @Valid Group	group
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
GroupScheduleAddEventRequest()
GroupScheduleAddEventRequest(HourMinute startTime, HourMinute endTime, Group group, ScheduleKey scheduleKey, String eventName, LocalDate startDate, LocalDate endDate)
GroupScheduleAddEventRequest(Group group, ScheduleKey scheduleKey, String eventName, LocalDate startDate, LocalDate endDate)
GroupScheduleAddEventRequest(Boolean allDayEvent, Group group, 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 Group.GroupScheduleAddEventRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
LocalDate	getEndDate()
HourMinute	getEndTime()
String	getEventName()
Group	getGroup()
Recurrence	getRecurrence()
ScheduleKey	getScheduleKey()
LocalDate	getStartDate()
HourMinute	getStartTime()
Group.GroupScheduleAddEventRequest	setEndDate(LocalDate endDate)
Group.GroupScheduleAddEventRequest	setEndTime(HourMinute endTime)
Group.GroupScheduleAddEventRequest	setEventName(String eventName)
Group.GroupScheduleAddEventRequest	setFlagAllDayEvent()
Group.GroupScheduleAddEventRequest	setGroup(Group group)
Group.GroupScheduleAddEventRequest	setRecurrence(Recurrence recurrence)
Group.GroupScheduleAddEventRequest	setScheduleKey(ScheduleKey scheduleKey)
Group.GroupScheduleAddEventRequest	setStartDate(LocalDate startDate)
Group.GroupScheduleAddEventRequest	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

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

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

GroupScheduleAddEventRequest

public GroupScheduleAddEventRequest()

GroupScheduleAddEventRequest

public GroupScheduleAddEventRequest(Group group,
 ScheduleKey scheduleKey,
 String eventName,
 LocalDate startDate,
 LocalDate endDate)

GroupScheduleAddEventRequest

public GroupScheduleAddEventRequest(Boolean allDayEvent,
 Group group,
 ScheduleKey scheduleKey,
 String eventName,
 LocalDate startDate,
 LocalDate endDate)

GroupScheduleAddEventRequest

public GroupScheduleAddEventRequest(HourMinute startTime,
 HourMinute endTime,
 Group group,
 ScheduleKey scheduleKey,
 String eventName,
 LocalDate startDate,
 LocalDate endDate)

Method Details

setGroup

public Group.GroupScheduleAddEventRequest setGroup(Group group)

getGroup

public Group getGroup()

setScheduleKey

public Group.GroupScheduleAddEventRequest setScheduleKey(ScheduleKey scheduleKey)

getScheduleKey

public ScheduleKey getScheduleKey()

setEventName

public Group.GroupScheduleAddEventRequest setEventName(String eventName)

getEventName

public String getEventName()

setStartDate

public Group.GroupScheduleAddEventRequest setStartDate(LocalDate startDate)

getStartDate

public LocalDate getStartDate()

setFlagAllDayEvent

public Group.GroupScheduleAddEventRequest setFlagAllDayEvent()

allDayEventFlagExist

public boolean allDayEventFlagExist()

getAllDayEvent

public Boolean getAllDayEvent()

setStartTime

public Group.GroupScheduleAddEventRequest setStartTime(HourMinute startTime)

getStartTime

public HourMinute getStartTime()

setEndTime

public Group.GroupScheduleAddEventRequest setEndTime(HourMinute endTime)

getEndTime

public HourMinute getEndTime()

setEndDate

public Group.GroupScheduleAddEventRequest setEndDate(LocalDate endDate)

getEndDate

public LocalDate getEndDate()

setRecurrence

public Group.GroupScheduleAddEventRequest setRecurrence(Recurrence recurrence)

getRecurrence

public Recurrence getRecurrence()

getEmptyObject

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