co.ecg.alpaca.toolkit.generated

Class User.UserScheduleDeleteEventListRequest

java.lang.Object

co.ecg.alpaca.toolkit.Request<Response.DefaultResponse>

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

All Implemented Interfaces:

Runnable

Enclosing class:

User

public static class User.UserScheduleDeleteEventListRequest
extends Request<Response.DefaultResponse>

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

Field Summary

Fields

Modifier and Type	Field and Description
String[]	eventName
boolean	eventNameIsModified
ScheduleKey	scheduleKey
boolean	scheduleKeyIsModified
User	user
boolean	userIsModified

Constructor Summary

Constructors

Constructor and Description
UserScheduleDeleteEventListRequest(BroadWorksServer bws) Default Constructor -- Not Guaranteed to work without checking Request validity with isValid()
UserScheduleDeleteEventListRequest(User user, ScheduleKey scheduleKey, String... eventName)

Method Summary

Modifier and Type	Method and Description
void	formRequest() Forms the XML Document for this Request Object.
String[]	getEventName()
ScheduleKey	getScheduleKey()
User	getUser()
User.UserScheduleDeleteEventListRequest	setEventName(String... eventName)
User.UserScheduleDeleteEventListRequest	setScheduleKey(ScheduleKey scheduleKey)
User.UserScheduleDeleteEventListRequest	setUser(User user)

Methods inherited from class co.ecg.alpaca.toolkit.Request

appendChild, appendChild, appendChild, asyncFire, createElement, createNilElement, createTextElement, fire, fire, getBroadWorksServer, getCommandType, getDomDocument, getResponseClass, isMemberOfBundle, isValid, run, setBroadWorksServer, setCommandElement, setCommandType, setDomDocument, setMemberOfBundle, setRequestId, setResponseClass, setRootElement, toString, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

user

@NotNull
public User user

userIsModified

public transient boolean userIsModified

scheduleKey

@NotNull
public ScheduleKey scheduleKey

scheduleKeyIsModified

public transient boolean scheduleKeyIsModified

eventName

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

eventNameIsModified

public transient boolean eventNameIsModified

Constructor Detail

UserScheduleDeleteEventListRequest

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

UserScheduleDeleteEventListRequest

public UserScheduleDeleteEventListRequest(BroadWorksServer bws)

Default Constructor -- Not Guaranteed to work without checking Request validity with isValid()

Parameters:

bws - The BroadWorksServer to use for the Request

Method Detail

setUser

public User.UserScheduleDeleteEventListRequest setUser(User user)

getUser

public User getUser()

setScheduleKey

public User.UserScheduleDeleteEventListRequest setScheduleKey(ScheduleKey scheduleKey)

getScheduleKey

public ScheduleKey getScheduleKey()

setEventName

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

getEventName

public String[] getEventName()

formRequest

public void formRequest()
                 throws RequestException

Forms the XML Document for this Request Object. Called by the Request upon fire().

Specified by:

formRequest in class Request<Response.DefaultResponse>

Throws:

RequestException