Package co.ecg.alpaca.toolkit.generated

Class User.UserScheduleAddRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.User.UserScheduleAddRequest

Enclosing class:

User

public static class User.UserScheduleAddRequest
extends Request<DefaultResponse>

Add 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 @NotNull @Size(min=1,max=40) String	scheduleName
protected @NotNull ScheduleType	scheduleType
protected @NotNull @Valid BroadWorksUser	user

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

log

Constructor Summary

Constructors

Constructor	Description
UserScheduleAddRequest()
UserScheduleAddRequest(BroadWorksUser user, String scheduleName, ScheduleType scheduleType)

Method Summary

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

user

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

scheduleName

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

scheduleType

@NotNull
protected @NotNull ScheduleType scheduleType

Constructor Detail

UserScheduleAddRequest

public UserScheduleAddRequest()

UserScheduleAddRequest

public UserScheduleAddRequest(BroadWorksUser user,
                              String scheduleName,
                              ScheduleType scheduleType)

Method Detail

setUser

public User.UserScheduleAddRequest setUser(BroadWorksUser user)

getBroadWorksUser

public BroadWorksUser getBroadWorksUser()

setScheduleName

public User.UserScheduleAddRequest setScheduleName(String scheduleName)

getScheduleName

public String getScheduleName()

setScheduleType

public User.UserScheduleAddRequest setScheduleType(ScheduleType scheduleType)

getScheduleType

public ScheduleType getScheduleType()

getEmptyObject

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