Package co.ecg.alpaca.toolkit.generated.services

Class UserExternalCustomRingback.UserExternalCustomRingbackModifyRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.services.UserExternalCustomRingback.UserExternalCustomRingbackModifyRequest

Enclosing class:

UserExternalCustomRingback

public static class UserExternalCustomRingback.UserExternalCustomRingbackModifyRequest
extends Request<DefaultResponse>

Modify the user level data associated with External Custom Ringback. The user SIP URI, when selected, it replaces the SP address, port and prefix. The user SIP URI, if selected, is the Request URI of the SIP INVITE sent to the external server. When the service provider data is used instead, the Request URI is constructed using the prefix, address, port and the user DN. The timeout value is the only SP configuration used when the user SIP URI is selected. 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 Boolean	isActive
protected Optional<@Size(min=1,max=1020) String>	sipRequestURI
protected @NotNull @Valid BroadWorksUser	user
protected ExternalCustomRingbackSettingLevel	useSettingLevel

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

log

Constructor Summary

Constructors

Constructor	Description
UserExternalCustomRingbackModifyRequest()
UserExternalCustomRingbackModifyRequest(BroadWorksUser user)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
BroadWorksUser	getBroadWorksUser()
static UserExternalCustomRingback.UserExternalCustomRingbackModifyRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
Boolean	getIsActive()
Optional<@Size(min=1,max=1020) String>	getSipRequestURI()
ExternalCustomRingbackSettingLevel	getUseSettingLevel()
UserExternalCustomRingback.UserExternalCustomRingbackModifyRequest	setIsActive(Boolean isActive)
UserExternalCustomRingback.UserExternalCustomRingbackModifyRequest	setSipRequestURI(String sipRequestURI)
UserExternalCustomRingback.UserExternalCustomRingbackModifyRequest	setUser(BroadWorksUser user)
UserExternalCustomRingback.UserExternalCustomRingbackModifyRequest	setUseSettingLevel(ExternalCustomRingbackSettingLevel useSettingLevel)
UserExternalCustomRingback.UserExternalCustomRingbackModifyRequest	unsetSipRequestURI()

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

isActive

protected Boolean isActive

useSettingLevel

protected ExternalCustomRingbackSettingLevel useSettingLevel

sipRequestURI

protected Optional<@Size(min=1,max=1020) String> sipRequestURI

Constructor Details

UserExternalCustomRingbackModifyRequest

public UserExternalCustomRingbackModifyRequest()

UserExternalCustomRingbackModifyRequest

public UserExternalCustomRingbackModifyRequest(BroadWorksUser user)

Method Details

setUser

public UserExternalCustomRingback.UserExternalCustomRingbackModifyRequest setUser(BroadWorksUser user)

getBroadWorksUser

public BroadWorksUser getBroadWorksUser()

setIsActive

public UserExternalCustomRingback.UserExternalCustomRingbackModifyRequest setIsActive(Boolean isActive)

getIsActive

public Boolean getIsActive()

setUseSettingLevel

public UserExternalCustomRingback.UserExternalCustomRingbackModifyRequest setUseSettingLevel(ExternalCustomRingbackSettingLevel useSettingLevel)

getUseSettingLevel

public ExternalCustomRingbackSettingLevel getUseSettingLevel()

unsetSipRequestURI

public UserExternalCustomRingback.UserExternalCustomRingbackModifyRequest unsetSipRequestURI()

setSipRequestURI

public UserExternalCustomRingback.UserExternalCustomRingbackModifyRequest setSipRequestURI(String sipRequestURI)

getSipRequestURI

public Optional<@Size(min=1,max=1020) String> getSipRequestURI()

getEmptyObject

public static UserExternalCustomRingback.UserExternalCustomRingbackModifyRequest 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>