Package co.ecg.alpaca.toolkit.generated

Class User.UserScheduleGetEventDetailListRequest

java.lang.Object

co.ecg.alpaca.toolkit.messaging.request.Request<User.UserScheduleGetEventDetailListResponse>

co.ecg.alpaca.toolkit.generated.User.UserScheduleGetEventDetailListRequest

Enclosing class:

User

public static class User.UserScheduleGetEventDetailListRequest
extends Request<User.UserScheduleGetEventDetailListResponse>

Request the list of schedules viewable by a User. The list can be filtered by schedule type. The response is either a UserScheduleGetEventListForGroupResponse 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 @Valid ScheduleGlobalKey	scheduleGlobalKey
protected @NotNull @Valid BroadWorksUser	user

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

log

Constructor Summary

Constructors

Constructor	Description
UserScheduleGetEventDetailListRequest()
UserScheduleGetEventDetailListRequest(BroadWorksUser user, ScheduleGlobalKey scheduleGlobalKey)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
BroadWorksUser	getBroadWorksUser()
static User.UserScheduleGetEventDetailListRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
ScheduleGlobalKey	getScheduleGlobalKey()
User.UserScheduleGetEventDetailListRequest	setScheduleGlobalKey(ScheduleGlobalKey scheduleGlobalKey)
User.UserScheduleGetEventDetailListRequest	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

scheduleGlobalKey

@NotNull
@Valid
protected @NotNull @Valid ScheduleGlobalKey scheduleGlobalKey

Constructor Detail

UserScheduleGetEventDetailListRequest

public UserScheduleGetEventDetailListRequest()

UserScheduleGetEventDetailListRequest

public UserScheduleGetEventDetailListRequest(BroadWorksUser user,
                                             ScheduleGlobalKey scheduleGlobalKey)

Method Detail

setUser

public User.UserScheduleGetEventDetailListRequest setUser(BroadWorksUser user)

getBroadWorksUser

public BroadWorksUser getBroadWorksUser()

setScheduleGlobalKey

public User.UserScheduleGetEventDetailListRequest setScheduleGlobalKey(ScheduleGlobalKey scheduleGlobalKey)

getScheduleGlobalKey

public ScheduleGlobalKey getScheduleGlobalKey()

getEmptyObject

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