co.ecg.alpaca.toolkit.generated

Class User.UserScheduleGetEventRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.User.UserScheduleGetEventRequest

Enclosing class:

User

@GwtIncompatible
public static class User.UserScheduleGetEventRequest
extends Request<User.UserScheduleGetEventResponse>

Get an event from a user schedule. The response is either a UserScheduleGetEventResponse 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 and Description
protected String	eventName
protected ScheduleKey	scheduleKey
protected BroadWorksUser	user

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

log

Constructor Summary

Constructors

Constructor and Description
UserScheduleGetEventRequest(BroadWorksUser user, ScheduleKey scheduleKey, String eventName)

Method Summary

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

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

appendChild, appendChild, appendChild, asyncFire, createElement, createNilElement, createTextElement, fire, fire, getBroadWorksServer, getCacheString, getCommandElement, getCommandType, getDomDocument, getId, getOCSProtocol, getRequestTimeoutMillis, getResponseClass, getRootElement, getValidationErrorsAsString, isMemberOfBundle, isValid, setBroadWorksServer, setCommandElement, setCommandType, setDomDocument, setMemberOfBundle, setRequestId, setRequestTimeoutMillis, 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
protected transient BroadWorksUser user

scheduleKey

@NotNull
protected ScheduleKey scheduleKey

eventName

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

Constructor Detail

UserScheduleGetEventRequest

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

Method Detail

setUser

public User.UserScheduleGetEventRequest setUser(BroadWorksUser user)

getBroadWorksUser

public BroadWorksUser getBroadWorksUser()

setScheduleKey

public User.UserScheduleGetEventRequest setScheduleKey(ScheduleKey scheduleKey)

getScheduleKey

public ScheduleKey getScheduleKey()

setEventName

public User.UserScheduleGetEventRequest setEventName(String eventName)

getEventName

public String getEventName()

getEmptyObject

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