Package 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

Enclosing class:

User

public static class User.UserScheduleModifyRequest
extends Request<DefaultResponse>

Modify a user schedule. The response is either a SuccessResponse 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 @Size(min=1,max=40) String	newScheduleName
protected @NotNull @Valid ScheduleKey	scheduleKey
protected @NotNull @Valid BroadWorksUser	user

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

log

Constructor Summary

Constructors

Constructor	Description
UserScheduleModifyRequest()
UserScheduleModifyRequest(BroadWorksUser user, ScheduleKey scheduleKey)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
BroadWorksUser	getBroadWorksUser()
static User.UserScheduleModifyRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
String	getNewScheduleName()
ScheduleKey	getScheduleKey()
User.UserScheduleModifyRequest	setNewScheduleName(String newScheduleName)
User.UserScheduleModifyRequest	setScheduleKey(ScheduleKey scheduleKey)
User.UserScheduleModifyRequest	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

scheduleKey

@NotNull
@Valid
protected @NotNull @Valid ScheduleKey scheduleKey

newScheduleName

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

Constructor Detail

UserScheduleModifyRequest

public UserScheduleModifyRequest()

UserScheduleModifyRequest

public UserScheduleModifyRequest(BroadWorksUser user,
                                 ScheduleKey scheduleKey)

Method Detail

setUser

public User.UserScheduleModifyRequest setUser(BroadWorksUser user)

getBroadWorksUser

public BroadWorksUser getBroadWorksUser()

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>