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

Class UserOutgoingCallingPlan.UserOutgoingCallingPlanSustainedAuthorizationCodeModifyRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.services.UserOutgoingCallingPlan.UserOutgoingCallingPlanSustainedAuthorizationCodeModifyRequest

Enclosing class:

UserOutgoingCallingPlan

public static class UserOutgoingCallingPlan.UserOutgoingCallingPlanSustainedAuthorizationCodeModifyRequest
extends Request<DefaultResponse>

Modify or clear the sustained authorization code for a user. The response is either a SuccessResponse or an ErrorResponse. Engineering Note: This command is used internally by Call Processing.

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<@Size(min=2,max=14) String>	code
protected @NotNull @Valid BroadWorksUser	user

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

log

Constructor Summary

Constructors

Constructor	Description
UserOutgoingCallingPlanSustainedAuthorizationCodeModifyRequest()
UserOutgoingCallingPlanSustainedAuthorizationCodeModifyRequest(BroadWorksUser user)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
BroadWorksUser	getBroadWorksUser()
Optional<@Size(min=2,max=14) String>	getCode()
static UserOutgoingCallingPlan.UserOutgoingCallingPlanSustainedAuthorizationCodeModifyRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
UserOutgoingCallingPlan.UserOutgoingCallingPlanSustainedAuthorizationCodeModifyRequest	setCode(String code)
UserOutgoingCallingPlan.UserOutgoingCallingPlanSustainedAuthorizationCodeModifyRequest	setUser(BroadWorksUser user)
UserOutgoingCallingPlan.UserOutgoingCallingPlanSustainedAuthorizationCodeModifyRequest	unsetCode()

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

user

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

code

protected Optional<@Size(min=2,max=14) String> code

Constructor Detail

UserOutgoingCallingPlanSustainedAuthorizationCodeModifyRequest

public UserOutgoingCallingPlanSustainedAuthorizationCodeModifyRequest()

UserOutgoingCallingPlanSustainedAuthorizationCodeModifyRequest

public UserOutgoingCallingPlanSustainedAuthorizationCodeModifyRequest(BroadWorksUser user)

Method Detail

setUser

public UserOutgoingCallingPlan.UserOutgoingCallingPlanSustainedAuthorizationCodeModifyRequest setUser(BroadWorksUser user)

getBroadWorksUser

public BroadWorksUser getBroadWorksUser()

unsetCode

public UserOutgoingCallingPlan.UserOutgoingCallingPlanSustainedAuthorizationCodeModifyRequest unsetCode()

setCode

public UserOutgoingCallingPlan.UserOutgoingCallingPlanSustainedAuthorizationCodeModifyRequest setCode(String code)

getCode

public Optional<@Size(min=2,max=14) String> getCode()

getEmptyObject

public static UserOutgoingCallingPlan.UserOutgoingCallingPlanSustainedAuthorizationCodeModifyRequest 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>