Package co.ecg.alpaca.toolkit.generated

Class User.UserShInterfaceGetPublicIdDataRequest

java.lang.Object

co.ecg.alpaca.toolkit.messaging.request.Request<User.UserShInterfaceGetPublicIdDataResponse>

co.ecg.alpaca.toolkit.generated.User.UserShInterfaceGetPublicIdDataRequest

Enclosing class:

User

public static class User.UserShInterfaceGetPublicIdDataRequest
extends Request<User.UserShInterfaceGetPublicIdDataResponse>

Returns the Sh non-transparent data stored against a Public User Identity (a SIP URI or TEL URI). The response is either a UserShInterfaceGetPublicIdDataResponse21sp1 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 PublicUserIdentity	publicUserIdentity

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

log

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
static User.UserShInterfaceGetPublicIdDataRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
PublicUserIdentity	getPublicUserIdentity()
User.UserShInterfaceGetPublicIdDataRequest	setPublicUserIdentity(PublicUserIdentity publicUserIdentity)

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

publicUserIdentity

@NotNull
@Valid
protected @NotNull @Valid PublicUserIdentity publicUserIdentity

Constructor Details

UserShInterfaceGetPublicIdDataRequest

public UserShInterfaceGetPublicIdDataRequest()

UserShInterfaceGetPublicIdDataRequest

public UserShInterfaceGetPublicIdDataRequest(BroadWorksServer broadWorksServer,
 PublicUserIdentity publicUserIdentity)

Method Details

setPublicUserIdentity

public User.UserShInterfaceGetPublicIdDataRequest setPublicUserIdentity(PublicUserIdentity publicUserIdentity)

getPublicUserIdentity

public PublicUserIdentity getPublicUserIdentity()

getEmptyObject

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