Package co.ecg.alpaca.toolkit.generated

Class ServiceProvider.ServiceProviderScheduleAddEventRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.ServiceProvider.ServiceProviderScheduleAddEventRequest

Enclosing class:

ServiceProvider

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

Add an event to service provider 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 @Valid ServiceProvider	serviceProvider
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
ServiceProviderScheduleAddEventRequest()
ServiceProviderScheduleAddEventRequest(HourMinute startTime, HourMinute endTime, ServiceProvider serviceProvider, ScheduleKey scheduleKey, String eventName, LocalDate startDate, LocalDate endDate)
ServiceProviderScheduleAddEventRequest(ServiceProvider serviceProvider, ScheduleKey scheduleKey, String eventName, LocalDate startDate, LocalDate endDate)
ServiceProviderScheduleAddEventRequest(Boolean allDayEvent, ServiceProvider serviceProvider, 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 ServiceProvider.ServiceProviderScheduleAddEventRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
LocalDate	getEndDate()
HourMinute	getEndTime()
String	getEventName()
Recurrence	getRecurrence()
ScheduleKey	getScheduleKey()
ServiceProvider	getServiceProvider()
LocalDate	getStartDate()
HourMinute	getStartTime()
ServiceProvider.ServiceProviderScheduleAddEventRequest	setEndDate(LocalDate endDate)
ServiceProvider.ServiceProviderScheduleAddEventRequest	setEndTime(HourMinute endTime)
ServiceProvider.ServiceProviderScheduleAddEventRequest	setEventName(String eventName)
ServiceProvider.ServiceProviderScheduleAddEventRequest	setFlagAllDayEvent()
ServiceProvider.ServiceProviderScheduleAddEventRequest	setRecurrence(Recurrence recurrence)
ServiceProvider.ServiceProviderScheduleAddEventRequest	setScheduleKey(ScheduleKey scheduleKey)
ServiceProvider.ServiceProviderScheduleAddEventRequest	setServiceProvider(ServiceProvider serviceProvider)
ServiceProvider.ServiceProviderScheduleAddEventRequest	setStartDate(LocalDate startDate)
ServiceProvider.ServiceProviderScheduleAddEventRequest	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, 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

serviceProvider

@NotNull
@Valid
protected transient @NotNull @Valid ServiceProvider serviceProvider

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 Detail

ServiceProviderScheduleAddEventRequest

public ServiceProviderScheduleAddEventRequest()

ServiceProviderScheduleAddEventRequest

public ServiceProviderScheduleAddEventRequest(ServiceProvider serviceProvider,
                                              ScheduleKey scheduleKey,
                                              String eventName,
                                              LocalDate startDate,
                                              LocalDate endDate)

ServiceProviderScheduleAddEventRequest

public ServiceProviderScheduleAddEventRequest(Boolean allDayEvent,
                                              ServiceProvider serviceProvider,
                                              ScheduleKey scheduleKey,
                                              String eventName,
                                              LocalDate startDate,
                                              LocalDate endDate)

ServiceProviderScheduleAddEventRequest

public ServiceProviderScheduleAddEventRequest(HourMinute startTime,
                                              HourMinute endTime,
                                              ServiceProvider serviceProvider,
                                              ScheduleKey scheduleKey,
                                              String eventName,
                                              LocalDate startDate,
                                              LocalDate endDate)

Method Detail

setServiceProvider

public ServiceProvider.ServiceProviderScheduleAddEventRequest setServiceProvider(ServiceProvider serviceProvider)

getServiceProvider

public ServiceProvider getServiceProvider()

setScheduleKey

public ServiceProvider.ServiceProviderScheduleAddEventRequest setScheduleKey(ScheduleKey scheduleKey)

getScheduleKey

public ScheduleKey getScheduleKey()

setEventName

public ServiceProvider.ServiceProviderScheduleAddEventRequest setEventName(String eventName)

getEventName

public String getEventName()

setStartDate

public ServiceProvider.ServiceProviderScheduleAddEventRequest setStartDate(LocalDate startDate)

getStartDate

public LocalDate getStartDate()

setFlagAllDayEvent

public ServiceProvider.ServiceProviderScheduleAddEventRequest setFlagAllDayEvent()

allDayEventFlagExist

public boolean allDayEventFlagExist()

getAllDayEvent

public Boolean getAllDayEvent()

setStartTime

public ServiceProvider.ServiceProviderScheduleAddEventRequest setStartTime(HourMinute startTime)

getStartTime

public HourMinute getStartTime()

setEndTime

public ServiceProvider.ServiceProviderScheduleAddEventRequest setEndTime(HourMinute endTime)

getEndTime

public HourMinute getEndTime()

setEndDate

public ServiceProvider.ServiceProviderScheduleAddEventRequest setEndDate(LocalDate endDate)

getEndDate

public LocalDate getEndDate()

setRecurrence

public ServiceProvider.ServiceProviderScheduleAddEventRequest setRecurrence(Recurrence recurrence)

getRecurrence

public Recurrence getRecurrence()

getEmptyObject

public static ServiceProvider.ServiceProviderScheduleAddEventRequest 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>