Package co.ecg.alpaca.toolkit.generated

Class User.UserTerminatingClosedUserGroupModifyRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.User.UserTerminatingClosedUserGroupModifyRequest

Enclosing class:

User

public static class User.UserTerminatingClosedUserGroupModifyRequest
extends Request<DefaultResponse>

Modify user Terminating CUG service settings. 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 @Valid BroadWorksUser	user
protected Optional<@Size(max=4) String>	userInterlockCode

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

log

Constructor Summary

Constructors

Constructor	Description
UserTerminatingClosedUserGroupModifyRequest()
UserTerminatingClosedUserGroupModifyRequest(BroadWorksUser user)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
BroadWorksUser	getBroadWorksUser()
static User.UserTerminatingClosedUserGroupModifyRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
Optional<@Size(max=4) String>	getUserInterlockCode()
User.UserTerminatingClosedUserGroupModifyRequest	setUser(BroadWorksUser user)
User.UserTerminatingClosedUserGroupModifyRequest	setUserInterlockCode(String userInterlockCode)
User.UserTerminatingClosedUserGroupModifyRequest	unsetUserInterlockCode()

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

userInterlockCode

protected Optional<@Size(max=4) String> userInterlockCode

Constructor Details

UserTerminatingClosedUserGroupModifyRequest

public UserTerminatingClosedUserGroupModifyRequest()

UserTerminatingClosedUserGroupModifyRequest

public UserTerminatingClosedUserGroupModifyRequest(BroadWorksUser user)

Method Details

setUser

public User.UserTerminatingClosedUserGroupModifyRequest setUser(BroadWorksUser user)

getBroadWorksUser

public BroadWorksUser getBroadWorksUser()

unsetUserInterlockCode

public User.UserTerminatingClosedUserGroupModifyRequest unsetUserInterlockCode()

setUserInterlockCode

public User.UserTerminatingClosedUserGroupModifyRequest setUserInterlockCode(String userInterlockCode)

getUserInterlockCode

public Optional<@Size(max=4) String> getUserInterlockCode()

getEmptyObject

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