Package co.ecg.alpaca.toolkit.generated

Class User.UserShInterfaceModifyRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.User.UserShInterfaceModifyRequest

Enclosing class:

User

public static class User.UserShInterfaceModifyRequest
extends Request<DefaultResponse>

Modifies the Sh Interface non-transparent data associated with a Public User Identity. The response is a 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 IMSUserState	iMSUserState
protected @NotNull @Valid PublicUserIdentity	publicUserIdentity
protected Optional<@Size(min=1,max=161) String>	sCSCFName

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

log

Constructor Summary

Constructors

Constructor	Description
UserShInterfaceModifyRequest()
UserShInterfaceModifyRequest(BroadWorksServer broadWorksServer, PublicUserIdentity publicUserIdentity)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
static User.UserShInterfaceModifyRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
IMSUserState	getIMSUserState()
PublicUserIdentity	getPublicUserIdentity()
Optional<@Size(min=1,max=161) String>	getSCSCFName()
User.UserShInterfaceModifyRequest	setIMSUserState(IMSUserState iMSUserState)
User.UserShInterfaceModifyRequest	setPublicUserIdentity(PublicUserIdentity publicUserIdentity)
User.UserShInterfaceModifyRequest	setSCSCFName(String sCSCFName)
User.UserShInterfaceModifyRequest	unsetSCSCFName()

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

publicUserIdentity

@NotNull
@Valid
protected @NotNull @Valid PublicUserIdentity publicUserIdentity

sCSCFName

protected Optional<@Size(min=1,max=161) String> sCSCFName

iMSUserState

protected IMSUserState iMSUserState

Constructor Detail

UserShInterfaceModifyRequest

public UserShInterfaceModifyRequest()

UserShInterfaceModifyRequest

public UserShInterfaceModifyRequest(BroadWorksServer broadWorksServer,
                                    PublicUserIdentity publicUserIdentity)

Method Detail

setPublicUserIdentity

public User.UserShInterfaceModifyRequest setPublicUserIdentity(PublicUserIdentity publicUserIdentity)

getPublicUserIdentity

public PublicUserIdentity getPublicUserIdentity()

unsetSCSCFName

public User.UserShInterfaceModifyRequest unsetSCSCFName()

setSCSCFName

public User.UserShInterfaceModifyRequest setSCSCFName(String sCSCFName)

getSCSCFName

public Optional<@Size(min=1,max=161) String> getSCSCFName()

setIMSUserState

public User.UserShInterfaceModifyRequest setIMSUserState(IMSUserState iMSUserState)

getIMSUserState

public IMSUserState getIMSUserState()

getEmptyObject

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