Package co.ecg.alpaca.toolkit.generated

Class BWSystem.SystemCommunicationBarringProfileModifyRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.BWSystem.SystemCommunicationBarringProfileModifyRequest

Enclosing class:

BWSystem

public static class BWSystem.SystemCommunicationBarringProfileModifyRequest
extends Request<DefaultResponse>

Modify an existing Communication Barring Profile. When the originatingDefaultAction is not Treatment, originatingDefaultTreatmentId will be automatically cleared. Also when the action of originatingRule is not Treatment, treatmentId will be automatically cleared for the rule. The priorities for IncomingRules are requantized to consecutive integers as part of the modify. The response is either a SuccessResponse or an ErrorResponse. The following elements are only used in AS data mode: callMeNowDefaultAction callMeNowDefaultCallTimeout callMeNowRule applyToAttendedCallTransfers

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	applyToAttendedCallTransfers
protected CommunicationBarringCallMeNowAction	callMeNowDefaultAction
protected Optional<Integer>	callMeNowDefaultCallTimeout
protected Optional<@Valid ReplacementCommunicationBarringCallMeNowRuleList>	callMeNowRule
protected Optional<@Size(min=1,max=80) String>	description
protected CommunicationBarringIncomingAction	incomingDefaultAction
protected Optional<Integer>	incomingDefaultCallTimeout
protected Optional<@Valid ReplacementCommunicationBarringIncomingRuleList19sp1>	incomingRule
protected @NotNull @Size(min=1,max=40) String	name
protected @Size(min=1,max=40) String	newName
protected CommunicationBarringOriginatingAction	originatingDefaultAction
protected Optional<Integer>	originatingDefaultCallTimeout
protected Optional<@Size(min=1,max=30) String>	originatingDefaultTransferNumber
protected Optional<@Size(min=1,max=40) String>	originatingDefaultTreatmentId
protected Optional<@Valid ReplacementCommunicationBarringOriginatingRuleList>	originatingRule
protected CommunicationBarringRedirectingAction	redirectingDefaultAction
protected Optional<Integer>	redirectingDefaultCallTimeout
protected Optional<@Valid ReplacementCommunicationBarringRedirectingRuleList>	redirectingRule

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

log

Constructor Summary

Constructors

Constructor	Description
SystemCommunicationBarringProfileModifyRequest()
SystemCommunicationBarringProfileModifyRequest(BroadWorksServer broadWorksServer, String name)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
Boolean	getApplyToAttendedCallTransfers()
CommunicationBarringCallMeNowAction	getCallMeNowDefaultAction()
Optional<Integer>	getCallMeNowDefaultCallTimeout()
Optional<@Valid ReplacementCommunicationBarringCallMeNowRuleList>	getCallMeNowRule()
Optional<@Size(min=1,max=80) String>	getDescription()
static BWSystem.SystemCommunicationBarringProfileModifyRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
CommunicationBarringIncomingAction	getIncomingDefaultAction()
Optional<Integer>	getIncomingDefaultCallTimeout()
Optional<@Valid ReplacementCommunicationBarringIncomingRuleList19sp1>	getIncomingRule()
String	getName()
String	getNewName()
CommunicationBarringOriginatingAction	getOriginatingDefaultAction()
Optional<Integer>	getOriginatingDefaultCallTimeout()
Optional<@Size(min=1,max=30) String>	getOriginatingDefaultTransferNumber()
Optional<@Size(min=1,max=40) String>	getOriginatingDefaultTreatmentId()
Optional<@Valid ReplacementCommunicationBarringOriginatingRuleList>	getOriginatingRule()
CommunicationBarringRedirectingAction	getRedirectingDefaultAction()
Optional<Integer>	getRedirectingDefaultCallTimeout()
Optional<@Valid ReplacementCommunicationBarringRedirectingRuleList>	getRedirectingRule()
BWSystem.SystemCommunicationBarringProfileModifyRequest	setApplyToAttendedCallTransfers(Boolean applyToAttendedCallTransfers)
BWSystem.SystemCommunicationBarringProfileModifyRequest	setCallMeNowDefaultAction(CommunicationBarringCallMeNowAction callMeNowDefaultAction)
BWSystem.SystemCommunicationBarringProfileModifyRequest	setCallMeNowDefaultCallTimeout(Integer callMeNowDefaultCallTimeout)
BWSystem.SystemCommunicationBarringProfileModifyRequest	setCallMeNowRule(ReplacementCommunicationBarringCallMeNowRuleList callMeNowRule)
BWSystem.SystemCommunicationBarringProfileModifyRequest	setDescription(String description)
BWSystem.SystemCommunicationBarringProfileModifyRequest	setIncomingDefaultAction(CommunicationBarringIncomingAction incomingDefaultAction)
BWSystem.SystemCommunicationBarringProfileModifyRequest	setIncomingDefaultCallTimeout(Integer incomingDefaultCallTimeout)
BWSystem.SystemCommunicationBarringProfileModifyRequest	setIncomingRule(ReplacementCommunicationBarringIncomingRuleList19sp1 incomingRule)
BWSystem.SystemCommunicationBarringProfileModifyRequest	setName(String name)
BWSystem.SystemCommunicationBarringProfileModifyRequest	setNewName(String newName)
BWSystem.SystemCommunicationBarringProfileModifyRequest	setOriginatingDefaultAction(CommunicationBarringOriginatingAction originatingDefaultAction)
BWSystem.SystemCommunicationBarringProfileModifyRequest	setOriginatingDefaultCallTimeout(Integer originatingDefaultCallTimeout)
BWSystem.SystemCommunicationBarringProfileModifyRequest	setOriginatingDefaultTransferNumber(String originatingDefaultTransferNumber)
BWSystem.SystemCommunicationBarringProfileModifyRequest	setOriginatingDefaultTreatmentId(String originatingDefaultTreatmentId)
BWSystem.SystemCommunicationBarringProfileModifyRequest	setOriginatingRule(ReplacementCommunicationBarringOriginatingRuleList originatingRule)
BWSystem.SystemCommunicationBarringProfileModifyRequest	setRedirectingDefaultAction(CommunicationBarringRedirectingAction redirectingDefaultAction)
BWSystem.SystemCommunicationBarringProfileModifyRequest	setRedirectingDefaultCallTimeout(Integer redirectingDefaultCallTimeout)
BWSystem.SystemCommunicationBarringProfileModifyRequest	setRedirectingRule(ReplacementCommunicationBarringRedirectingRuleList redirectingRule)
BWSystem.SystemCommunicationBarringProfileModifyRequest	unsetCallMeNowDefaultCallTimeout()
BWSystem.SystemCommunicationBarringProfileModifyRequest	unsetCallMeNowRule()
BWSystem.SystemCommunicationBarringProfileModifyRequest	unsetDescription()
BWSystem.SystemCommunicationBarringProfileModifyRequest	unsetIncomingDefaultCallTimeout()
BWSystem.SystemCommunicationBarringProfileModifyRequest	unsetIncomingRule()
BWSystem.SystemCommunicationBarringProfileModifyRequest	unsetOriginatingDefaultCallTimeout()
BWSystem.SystemCommunicationBarringProfileModifyRequest	unsetOriginatingDefaultTransferNumber()
BWSystem.SystemCommunicationBarringProfileModifyRequest	unsetOriginatingDefaultTreatmentId()
BWSystem.SystemCommunicationBarringProfileModifyRequest	unsetOriginatingRule()
BWSystem.SystemCommunicationBarringProfileModifyRequest	unsetRedirectingDefaultCallTimeout()
BWSystem.SystemCommunicationBarringProfileModifyRequest	unsetRedirectingRule()

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

name

@NotNull
@Size(min=1,
      max=40)
protected @NotNull @Size(min=1,max=40) String name

newName

@Size(min=1,
      max=40)
protected @Size(min=1,max=40) String newName

description

protected Optional<@Size(min=1,max=80) String> description

originatingDefaultAction

protected CommunicationBarringOriginatingAction originatingDefaultAction

originatingDefaultTreatmentId

protected Optional<@Size(min=1,max=40) String> originatingDefaultTreatmentId

originatingDefaultTransferNumber

protected Optional<@Size(min=1,max=30) String> originatingDefaultTransferNumber

originatingDefaultCallTimeout

protected Optional<Integer> originatingDefaultCallTimeout

originatingRule

protected Optional<@Valid ReplacementCommunicationBarringOriginatingRuleList> originatingRule

redirectingDefaultAction

protected CommunicationBarringRedirectingAction redirectingDefaultAction

redirectingDefaultCallTimeout

protected Optional<Integer> redirectingDefaultCallTimeout

redirectingRule

protected Optional<@Valid ReplacementCommunicationBarringRedirectingRuleList> redirectingRule

incomingDefaultAction

protected CommunicationBarringIncomingAction incomingDefaultAction

incomingDefaultCallTimeout

protected Optional<Integer> incomingDefaultCallTimeout

incomingRule

protected Optional<@Valid ReplacementCommunicationBarringIncomingRuleList19sp1> incomingRule

callMeNowDefaultAction

protected CommunicationBarringCallMeNowAction callMeNowDefaultAction

callMeNowDefaultCallTimeout

protected Optional<Integer> callMeNowDefaultCallTimeout

callMeNowRule

protected Optional<@Valid ReplacementCommunicationBarringCallMeNowRuleList> callMeNowRule

applyToAttendedCallTransfers

protected Boolean applyToAttendedCallTransfers

Constructor Details

SystemCommunicationBarringProfileModifyRequest

public SystemCommunicationBarringProfileModifyRequest()

SystemCommunicationBarringProfileModifyRequest

public SystemCommunicationBarringProfileModifyRequest(BroadWorksServer broadWorksServer,
 String name)

Method Details

setName

public BWSystem.SystemCommunicationBarringProfileModifyRequest setName(String name)

getName

public String getName()

setNewName

public BWSystem.SystemCommunicationBarringProfileModifyRequest setNewName(String newName)

getNewName

public String getNewName()

unsetDescription

public BWSystem.SystemCommunicationBarringProfileModifyRequest unsetDescription()

setDescription

public BWSystem.SystemCommunicationBarringProfileModifyRequest setDescription(String description)

getDescription

public Optional<@Size(min=1,max=80) String> getDescription()

setOriginatingDefaultAction

public BWSystem.SystemCommunicationBarringProfileModifyRequest setOriginatingDefaultAction(CommunicationBarringOriginatingAction originatingDefaultAction)

getOriginatingDefaultAction

public CommunicationBarringOriginatingAction getOriginatingDefaultAction()

unsetOriginatingDefaultTreatmentId

public BWSystem.SystemCommunicationBarringProfileModifyRequest unsetOriginatingDefaultTreatmentId()

setOriginatingDefaultTreatmentId

public BWSystem.SystemCommunicationBarringProfileModifyRequest setOriginatingDefaultTreatmentId(String originatingDefaultTreatmentId)

getOriginatingDefaultTreatmentId

public Optional<@Size(min=1,max=40) String> getOriginatingDefaultTreatmentId()

unsetOriginatingDefaultTransferNumber

public BWSystem.SystemCommunicationBarringProfileModifyRequest unsetOriginatingDefaultTransferNumber()

setOriginatingDefaultTransferNumber

public BWSystem.SystemCommunicationBarringProfileModifyRequest setOriginatingDefaultTransferNumber(String originatingDefaultTransferNumber)

getOriginatingDefaultTransferNumber

public Optional<@Size(min=1,max=30) String> getOriginatingDefaultTransferNumber()

unsetOriginatingDefaultCallTimeout

public BWSystem.SystemCommunicationBarringProfileModifyRequest unsetOriginatingDefaultCallTimeout()

setOriginatingDefaultCallTimeout

public BWSystem.SystemCommunicationBarringProfileModifyRequest setOriginatingDefaultCallTimeout(Integer originatingDefaultCallTimeout)

getOriginatingDefaultCallTimeout

public Optional<Integer> getOriginatingDefaultCallTimeout()

unsetOriginatingRule

public BWSystem.SystemCommunicationBarringProfileModifyRequest unsetOriginatingRule()

setOriginatingRule

public BWSystem.SystemCommunicationBarringProfileModifyRequest setOriginatingRule(ReplacementCommunicationBarringOriginatingRuleList originatingRule)

getOriginatingRule

public Optional<@Valid ReplacementCommunicationBarringOriginatingRuleList> getOriginatingRule()

setRedirectingDefaultAction

public BWSystem.SystemCommunicationBarringProfileModifyRequest setRedirectingDefaultAction(CommunicationBarringRedirectingAction redirectingDefaultAction)

getRedirectingDefaultAction

public CommunicationBarringRedirectingAction getRedirectingDefaultAction()

unsetRedirectingDefaultCallTimeout

public BWSystem.SystemCommunicationBarringProfileModifyRequest unsetRedirectingDefaultCallTimeout()

setRedirectingDefaultCallTimeout

public BWSystem.SystemCommunicationBarringProfileModifyRequest setRedirectingDefaultCallTimeout(Integer redirectingDefaultCallTimeout)

getRedirectingDefaultCallTimeout

public Optional<Integer> getRedirectingDefaultCallTimeout()

unsetRedirectingRule

public BWSystem.SystemCommunicationBarringProfileModifyRequest unsetRedirectingRule()

setRedirectingRule

public BWSystem.SystemCommunicationBarringProfileModifyRequest setRedirectingRule(ReplacementCommunicationBarringRedirectingRuleList redirectingRule)

getRedirectingRule

public Optional<@Valid ReplacementCommunicationBarringRedirectingRuleList> getRedirectingRule()

setIncomingDefaultAction

public BWSystem.SystemCommunicationBarringProfileModifyRequest setIncomingDefaultAction(CommunicationBarringIncomingAction incomingDefaultAction)

getIncomingDefaultAction

public CommunicationBarringIncomingAction getIncomingDefaultAction()

unsetIncomingDefaultCallTimeout

public BWSystem.SystemCommunicationBarringProfileModifyRequest unsetIncomingDefaultCallTimeout()

setIncomingDefaultCallTimeout

public BWSystem.SystemCommunicationBarringProfileModifyRequest setIncomingDefaultCallTimeout(Integer incomingDefaultCallTimeout)

getIncomingDefaultCallTimeout

public Optional<Integer> getIncomingDefaultCallTimeout()

unsetIncomingRule

public BWSystem.SystemCommunicationBarringProfileModifyRequest unsetIncomingRule()

setIncomingRule

public BWSystem.SystemCommunicationBarringProfileModifyRequest setIncomingRule(ReplacementCommunicationBarringIncomingRuleList19sp1 incomingRule)

getIncomingRule

public Optional<@Valid ReplacementCommunicationBarringIncomingRuleList19sp1> getIncomingRule()

setCallMeNowDefaultAction

public BWSystem.SystemCommunicationBarringProfileModifyRequest setCallMeNowDefaultAction(CommunicationBarringCallMeNowAction callMeNowDefaultAction)

getCallMeNowDefaultAction

public CommunicationBarringCallMeNowAction getCallMeNowDefaultAction()

unsetCallMeNowDefaultCallTimeout

public BWSystem.SystemCommunicationBarringProfileModifyRequest unsetCallMeNowDefaultCallTimeout()

setCallMeNowDefaultCallTimeout

public BWSystem.SystemCommunicationBarringProfileModifyRequest setCallMeNowDefaultCallTimeout(Integer callMeNowDefaultCallTimeout)

getCallMeNowDefaultCallTimeout

public Optional<Integer> getCallMeNowDefaultCallTimeout()

unsetCallMeNowRule

public BWSystem.SystemCommunicationBarringProfileModifyRequest unsetCallMeNowRule()

setCallMeNowRule

public BWSystem.SystemCommunicationBarringProfileModifyRequest setCallMeNowRule(ReplacementCommunicationBarringCallMeNowRuleList callMeNowRule)

getCallMeNowRule

public Optional<@Valid ReplacementCommunicationBarringCallMeNowRuleList> getCallMeNowRule()

setApplyToAttendedCallTransfers

public BWSystem.SystemCommunicationBarringProfileModifyRequest setApplyToAttendedCallTransfers(Boolean applyToAttendedCallTransfers)

getApplyToAttendedCallTransfers

public Boolean getApplyToAttendedCallTransfers()

getEmptyObject

public static BWSystem.SystemCommunicationBarringProfileModifyRequest 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>