co.ecg.alpaca.toolkit.generated

Class User.UserScheduleAddRequest

java.lang.Object

co.ecg.alpaca.toolkit.Request<Response.DefaultResponse>

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

All Implemented Interfaces:

Runnable

Enclosing class:

User

public static class User.UserScheduleAddRequest
extends Request<Response.DefaultResponse>

Add a user schedule. The response is either a SuccessResponse or an ErrorResponse.

Field Summary

Fields

Modifier and Type	Field and Description
String	scheduleName
boolean	scheduleNameIsModified
ScheduleType	scheduleType
boolean	scheduleTypeIsModified
User	user
boolean	userIsModified

Constructor Summary

Constructors

Constructor and Description
UserScheduleAddRequest(BroadWorksServer bws) Default Constructor -- Not Guaranteed to work without checking Request validity with isValid()
UserScheduleAddRequest(User user, String scheduleName, ScheduleType scheduleType)

Method Summary

Modifier and Type	Method and Description
void	formRequest() Forms the XML Document for this Request Object.
String	getScheduleName()
ScheduleType	getScheduleType()
User	getUser()
User.UserScheduleAddRequest	setScheduleName(String scheduleName)
User.UserScheduleAddRequest	setScheduleType(ScheduleType scheduleType)
User.UserScheduleAddRequest	setUser(User user)

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

appendChild, appendChild, appendChild, asyncFire, createElement, createNilElement, createTextElement, fire, fire, getBroadWorksServer, getCommandType, getDomDocument, getResponseClass, 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
public User user

userIsModified

public transient boolean userIsModified

scheduleName

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

scheduleNameIsModified

public transient boolean scheduleNameIsModified

scheduleType

public ScheduleType scheduleType

scheduleTypeIsModified

public transient boolean scheduleTypeIsModified

Constructor Detail

UserScheduleAddRequest

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

UserScheduleAddRequest

public UserScheduleAddRequest(BroadWorksServer bws)

Default Constructor -- Not Guaranteed to work without checking Request validity with isValid()

Parameters:

bws - The BroadWorksServer to use for the Request

Method Detail

setUser

public User.UserScheduleAddRequest setUser(User user)

getUser

public User getUser()

setScheduleName

public User.UserScheduleAddRequest setScheduleName(String scheduleName)

getScheduleName

public String getScheduleName()

setScheduleType

public User.UserScheduleAddRequest setScheduleType(ScheduleType scheduleType)

getScheduleType

public ScheduleType getScheduleType()

formRequest

public void formRequest()
                 throws RequestException

Forms the XML Document for this Request Object. Called by the Request upon fire().

Specified by:

formRequest in class Request<Response.DefaultResponse>

Throws:

RequestException