Package co.ecg.alpaca.toolkit.generated

Class User.UserScheduleModifyEventRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.User.UserScheduleModifyEventRequest

Enclosing class:

User

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

Modify an event of a user 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 LocalDate	startDate
protected @Valid HourMinute	startTime
protected @NotNull @Valid BroadWorksUser	user

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

log

Constructor Summary

Constructors

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

user

@NotNull
@Valid
protected transient @NotNull @Valid BroadWorksUser user

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 Details

UserScheduleModifyEventRequest

public UserScheduleModifyEventRequest()

UserScheduleModifyEventRequest

public UserScheduleModifyEventRequest(BroadWorksUser user,
 ScheduleKey scheduleKey,
 String eventName)

Method Details

setUser

public User.UserScheduleModifyEventRequest setUser(BroadWorksUser user)

getBroadWorksUser

public BroadWorksUser getBroadWorksUser()

setScheduleKey

public User.UserScheduleModifyEventRequest setScheduleKey(ScheduleKey scheduleKey)

getScheduleKey

public ScheduleKey getScheduleKey()

setEventName

public User.UserScheduleModifyEventRequest setEventName(String eventName)

getEventName

public String getEventName()

setNewEventName

public User.UserScheduleModifyEventRequest setNewEventName(String newEventName)

getNewEventName

public String getNewEventName()

setStartDate

public User.UserScheduleModifyEventRequest setStartDate(LocalDate startDate)

getStartDate

public LocalDate getStartDate()

setFlagAllDayEvent

public User.UserScheduleModifyEventRequest setFlagAllDayEvent()

allDayEventFlagExist

public boolean allDayEventFlagExist()

getAllDayEvent

public Boolean getAllDayEvent()

setStartTime

public User.UserScheduleModifyEventRequest setStartTime(HourMinute startTime)

getStartTime

public HourMinute getStartTime()

setEndTime

public User.UserScheduleModifyEventRequest setEndTime(HourMinute endTime)

getEndTime

public HourMinute getEndTime()

setEndDate

public User.UserScheduleModifyEventRequest setEndDate(LocalDate endDate)

getEndDate

public LocalDate getEndDate()

unsetRecurrence

public User.UserScheduleModifyEventRequest unsetRecurrence()

setRecurrence

public User.UserScheduleModifyEventRequest setRecurrence(Recurrence recurrence)

getRecurrence

public Optional<@Valid Recurrence> getRecurrence()

getEmptyObject

public static User.UserScheduleModifyEventRequest 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>