co.ecg.alpaca.toolkit.generated.services

Class AutomaticHoldRetrieve.UserAutomaticHoldRetrieveModifyRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.services.AutomaticHoldRetrieve.UserAutomaticHoldRetrieveModifyRequest

All Implemented Interfaces:

Runnable

Enclosing class:

AutomaticHoldRetrieve

public static class AutomaticHoldRetrieve.UserAutomaticHoldRetrieveModifyRequest
extends Request<Response.DefaultResponse>

Modify the user level data associated with Automatic Hold/Retrieve. The response is either a SuccessResponse or an ErrorResponse.

Field Summary

Fields

Modifier and Type	Field and Description
Boolean	isActive
boolean	isActiveIsModified
Integer	recallTimerSeconds
boolean	recallTimerSecondsIsModified
User	user
boolean	userIsModified

Constructor Summary

Constructors

Constructor and Description
UserAutomaticHoldRetrieveModifyRequest(BroadWorksServer bws) Default Constructor -- Not Guaranteed to work without checking Request validity with isValid()
UserAutomaticHoldRetrieveModifyRequest(User user)

Method Summary

Modifier and Type	Method and Description
void	formRequest() Forms the XML Document for this Request Object.
Boolean	getIsActive()
Integer	getRecallTimerSeconds()
User	getUser()
AutomaticHoldRetrieve.UserAutomaticHoldRetrieveModifyRequest	setIsActive(Boolean isActive)
AutomaticHoldRetrieve.UserAutomaticHoldRetrieveModifyRequest	setRecallTimerSeconds(Integer recallTimerSeconds)
AutomaticHoldRetrieve.UserAutomaticHoldRetrieveModifyRequest	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

isActive

public Boolean isActive

isActiveIsModified

public transient boolean isActiveIsModified

recallTimerSeconds

public Integer recallTimerSeconds

recallTimerSecondsIsModified

public transient boolean recallTimerSecondsIsModified

Constructor Detail

UserAutomaticHoldRetrieveModifyRequest

public UserAutomaticHoldRetrieveModifyRequest(User user)

UserAutomaticHoldRetrieveModifyRequest

public UserAutomaticHoldRetrieveModifyRequest(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 AutomaticHoldRetrieve.UserAutomaticHoldRetrieveModifyRequest setUser(User user)

getUser

public User getUser()

setIsActive

public AutomaticHoldRetrieve.UserAutomaticHoldRetrieveModifyRequest setIsActive(Boolean isActive)

getIsActive

public Boolean getIsActive()

setRecallTimerSeconds

public AutomaticHoldRetrieve.UserAutomaticHoldRetrieveModifyRequest setRecallTimerSeconds(Integer recallTimerSeconds)

getRecallTimerSeconds

public Integer getRecallTimerSeconds()

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