co.ecg.alpaca.toolkit.generated

Class User.UserScheduleModifyRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.User.UserScheduleModifyRequest

All Implemented Interfaces:

Runnable

Enclosing class:

User

@GwtIncompatible
public static class User.UserScheduleModifyRequest
extends Request<DefaultResponse>

AlpacaLibrary Auto-Generated Java File Modify a user schedule. The response is either a SuccessResponse or an ErrorResponse.

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	newScheduleName
protected ScheduleKey	scheduleKey
protected User	user

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

log

Constructor Summary

Constructors

Constructor and Description
UserScheduleModifyRequest(User user, ScheduleKey scheduleKey)

Method Summary

Modifier and Type	Method and Description
void	formRequest() Forms the XML Document for this Request Object.
static User.UserScheduleModifyRequest	getEmptyObject(BroadWorksServer broadWorksServer) Retrieves this object with minimal setup.
String	getNewScheduleName()
ScheduleKey	getScheduleKey()
User	getUser()
User.UserScheduleModifyRequest	setNewScheduleName(String newScheduleName)
User.UserScheduleModifyRequest	setScheduleKey(ScheduleKey scheduleKey)
User.UserScheduleModifyRequest	setUser(User user)

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

appendChild, appendChild, appendChild, asyncFire, createDocument, createElement, createNilElement, createTextElement, fire, fire, getBroadWorksServer, getCommandElement, getCommandType, getDomDocument, getId, getResponseClass, getRootElement, 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
protected transient User user

scheduleKey

@NotNull
protected ScheduleKey scheduleKey

newScheduleName

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

Constructor Detail

UserScheduleModifyRequest

public UserScheduleModifyRequest(User user,
                                 ScheduleKey scheduleKey)

Method Detail

setUser

public User.UserScheduleModifyRequest setUser(User user)

getUser

public User getUser()

setScheduleKey

public User.UserScheduleModifyRequest setScheduleKey(ScheduleKey scheduleKey)

getScheduleKey

public ScheduleKey getScheduleKey()

setNewScheduleName

public User.UserScheduleModifyRequest setNewScheduleName(String newScheduleName)

getNewScheduleName

public String getNewScheduleName()

getEmptyObject

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