Package co.ecg.alpaca.toolkit.generated

Class User.UserScheduleGetListRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.User.UserScheduleGetListRequest

Enclosing class:

User

public static class User.UserScheduleGetListRequest
extends Request<User.UserScheduleGetListResponse>

Get the list of schedules viewable by a User. The list can be filtered by schedule type. The response is either a UserScheduleGetListResponse17sp1 or an ErrorResponse. This command is authorized to user who is Executive-Assistant of the Executive.

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 ScheduleType	scheduleType
protected @NotNull @Valid BroadWorksUser	user

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

log

Constructor Summary

Constructors

Constructor	Description
UserScheduleGetListRequest()
UserScheduleGetListRequest(BroadWorksUser user)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
BroadWorksUser	getBroadWorksUser()
static User.UserScheduleGetListRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
ScheduleType	getScheduleType()
User.UserScheduleGetListRequest	setScheduleType(ScheduleType scheduleType)
User.UserScheduleGetListRequest	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, 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 Details

user

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

scheduleType

protected ScheduleType scheduleType

Constructor Details

UserScheduleGetListRequest

public UserScheduleGetListRequest()

UserScheduleGetListRequest

public UserScheduleGetListRequest(BroadWorksUser user)

Method Details

setUser

public User.UserScheduleGetListRequest setUser(BroadWorksUser user)

getBroadWorksUser

public BroadWorksUser getBroadWorksUser()

setScheduleType

public User.UserScheduleGetListRequest setScheduleType(ScheduleType scheduleType)

getScheduleType

public ScheduleType getScheduleType()

getEmptyObject

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