Package co.ecg.alpaca.toolkit.generated

Class RoutePoint.UserRoutePointSupervisorModifyListRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.RoutePoint.UserRoutePointSupervisorModifyListRequest

Enclosing class:

RoutePoint

public static class RoutePoint.UserRoutePointSupervisorModifyListRequest
extends Request<DefaultResponse>

Request to modify the Route Point supervisor list for a user. The response is either SuccessResponse or 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 Optional<@Valid ReplacementUserIdList>	supervisorUserIdList
protected @NotNull @Valid BroadWorksUser	user

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

log

Constructor Summary

Constructors

Constructor	Description
UserRoutePointSupervisorModifyListRequest()
UserRoutePointSupervisorModifyListRequest(BroadWorksUser user)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
BroadWorksUser	getBroadWorksUser()
static RoutePoint.UserRoutePointSupervisorModifyListRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
Optional<@Valid ReplacementUserIdList>	getSupervisorUserIdList()
RoutePoint.UserRoutePointSupervisorModifyListRequest	setSupervisorUserIdList(ReplacementUserIdList supervisorUserIdList)
RoutePoint.UserRoutePointSupervisorModifyListRequest	setUser(BroadWorksUser user)
RoutePoint.UserRoutePointSupervisorModifyListRequest	unsetSupervisorUserIdList()

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 Details

user

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

supervisorUserIdList

protected Optional<@Valid ReplacementUserIdList> supervisorUserIdList

Constructor Details

UserRoutePointSupervisorModifyListRequest

public UserRoutePointSupervisorModifyListRequest()

UserRoutePointSupervisorModifyListRequest

public UserRoutePointSupervisorModifyListRequest(BroadWorksUser user)

Method Details

setUser

public RoutePoint.UserRoutePointSupervisorModifyListRequest setUser(BroadWorksUser user)

getBroadWorksUser

public BroadWorksUser getBroadWorksUser()

unsetSupervisorUserIdList

public RoutePoint.UserRoutePointSupervisorModifyListRequest unsetSupervisorUserIdList()

setSupervisorUserIdList

public RoutePoint.UserRoutePointSupervisorModifyListRequest setSupervisorUserIdList(ReplacementUserIdList supervisorUserIdList)

getSupervisorUserIdList

public Optional<@Valid ReplacementUserIdList> getSupervisorUserIdList()

getEmptyObject

public static RoutePoint.UserRoutePointSupervisorModifyListRequest 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>