Package co.ecg.alpaca.toolkit.generated

Class ServiceProvider.ServiceProviderScheduleModifyEventRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.ServiceProvider.ServiceProviderScheduleModifyEventRequest

Enclosing class:

ServiceProvider

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

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

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

log

Constructor Summary

Constructors

Constructor	Description
ServiceProviderScheduleModifyEventRequest()
ServiceProviderScheduleModifyEventRequest(ServiceProvider serviceProvider, 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 ServiceProvider.ServiceProviderScheduleModifyEventRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
LocalDate	getEndDate()
HourMinute	getEndTime()
String	getEventName()
String	getNewEventName()
Optional<@Valid Recurrence>	getRecurrence()
ScheduleKey	getScheduleKey()
ServiceProvider	getServiceProvider()
LocalDate	getStartDate()
HourMinute	getStartTime()
ServiceProvider.ServiceProviderScheduleModifyEventRequest	setEndDate(LocalDate endDate)
ServiceProvider.ServiceProviderScheduleModifyEventRequest	setEndTime(HourMinute endTime)
ServiceProvider.ServiceProviderScheduleModifyEventRequest	setEventName(String eventName)
ServiceProvider.ServiceProviderScheduleModifyEventRequest	setFlagAllDayEvent()
ServiceProvider.ServiceProviderScheduleModifyEventRequest	setNewEventName(String newEventName)
ServiceProvider.ServiceProviderScheduleModifyEventRequest	setRecurrence(Recurrence recurrence)
ServiceProvider.ServiceProviderScheduleModifyEventRequest	setScheduleKey(ScheduleKey scheduleKey)
ServiceProvider.ServiceProviderScheduleModifyEventRequest	setServiceProvider(ServiceProvider serviceProvider)
ServiceProvider.ServiceProviderScheduleModifyEventRequest	setStartDate(LocalDate startDate)
ServiceProvider.ServiceProviderScheduleModifyEventRequest	setStartTime(HourMinute startTime)
ServiceProvider.ServiceProviderScheduleModifyEventRequest	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

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

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

ServiceProviderScheduleModifyEventRequest

public ServiceProviderScheduleModifyEventRequest()

ServiceProviderScheduleModifyEventRequest

public ServiceProviderScheduleModifyEventRequest(ServiceProvider serviceProvider,
                                                 ScheduleKey scheduleKey,
                                                 String eventName)

Method Detail

setServiceProvider

public ServiceProvider.ServiceProviderScheduleModifyEventRequest setServiceProvider(ServiceProvider serviceProvider)

getServiceProvider

public ServiceProvider getServiceProvider()

setScheduleKey

public ServiceProvider.ServiceProviderScheduleModifyEventRequest setScheduleKey(ScheduleKey scheduleKey)

getScheduleKey

public ScheduleKey getScheduleKey()

setEventName

public ServiceProvider.ServiceProviderScheduleModifyEventRequest setEventName(String eventName)

getEventName

public String getEventName()

setNewEventName

public ServiceProvider.ServiceProviderScheduleModifyEventRequest setNewEventName(String newEventName)

getNewEventName

public String getNewEventName()

setStartDate

public ServiceProvider.ServiceProviderScheduleModifyEventRequest setStartDate(LocalDate startDate)

getStartDate

public LocalDate getStartDate()

setFlagAllDayEvent

public ServiceProvider.ServiceProviderScheduleModifyEventRequest setFlagAllDayEvent()

allDayEventFlagExist

public boolean allDayEventFlagExist()

getAllDayEvent

public Boolean getAllDayEvent()

setStartTime

public ServiceProvider.ServiceProviderScheduleModifyEventRequest setStartTime(HourMinute startTime)

getStartTime

public HourMinute getStartTime()

setEndTime

public ServiceProvider.ServiceProviderScheduleModifyEventRequest setEndTime(HourMinute endTime)

getEndTime

public HourMinute getEndTime()

setEndDate

public ServiceProvider.ServiceProviderScheduleModifyEventRequest setEndDate(LocalDate endDate)

getEndDate

public LocalDate getEndDate()

unsetRecurrence

public ServiceProvider.ServiceProviderScheduleModifyEventRequest unsetRecurrence()

setRecurrence

public ServiceProvider.ServiceProviderScheduleModifyEventRequest setRecurrence(Recurrence recurrence)

getRecurrence

public Optional<@Valid Recurrence> getRecurrence()

getEmptyObject

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