Package co.ecg.alpaca.toolkit.generated

Class User.UserScheduleDeleteEventListRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.User.UserScheduleDeleteEventListRequest

Enclosing class:

User

public static class User.UserScheduleDeleteEventListRequest
extends Request<DefaultResponse>

Delete a list of events from a user schedule. The response is either a SuccessResponse or an ErrorResponse.

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 @NotNull @Size(min=1) String[]	eventName
protected @NotNull @Valid ScheduleKey	scheduleKey
protected @NotNull @Valid BroadWorksUser	user

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

log

Constructor Summary

Constructors

Constructor	Description
UserScheduleDeleteEventListRequest()
UserScheduleDeleteEventListRequest(BroadWorksUser user, ScheduleKey scheduleKey, String... eventName)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
BroadWorksUser	getBroadWorksUser()
static User.UserScheduleDeleteEventListRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
String[]	getEventName()
ScheduleKey	getScheduleKey()
User.UserScheduleDeleteEventListRequest	setEventName(String... eventName)
User.UserScheduleDeleteEventListRequest	setScheduleKey(ScheduleKey scheduleKey)
User.UserScheduleDeleteEventListRequest	setUser(BroadWorksUser user)

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 Detail

user

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

scheduleKey

@NotNull
@Valid
protected @NotNull @Valid ScheduleKey scheduleKey

eventName

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

Constructor Detail

UserScheduleDeleteEventListRequest

public UserScheduleDeleteEventListRequest()

UserScheduleDeleteEventListRequest

public UserScheduleDeleteEventListRequest(BroadWorksUser user,
                                          ScheduleKey scheduleKey,
                                          String... eventName)

Method Detail

setUser

public User.UserScheduleDeleteEventListRequest setUser(BroadWorksUser user)

getBroadWorksUser

public BroadWorksUser getBroadWorksUser()

setScheduleKey

public User.UserScheduleDeleteEventListRequest setScheduleKey(ScheduleKey scheduleKey)

getScheduleKey

public ScheduleKey getScheduleKey()

setEventName

public User.UserScheduleDeleteEventListRequest setEventName(String... eventName)

getEventName

public String[] getEventName()

getEmptyObject

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