Package co.ecg.alpaca.toolkit.generated

Class BWSystem.SystemCommunicationBarringProfileAddRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.BWSystem.SystemCommunicationBarringProfileAddRequest

Enclosing class:

BWSystem

public static class BWSystem.SystemCommunicationBarringProfileAddRequest
extends Request<DefaultResponse>

Add a new Communication Barring Profile. The priorities for IncomingRules are requantized to consecutive integers as part of the add. The response is either a SuccessResponse or an ErrorResponse. The following elements are only used in AS data mode: callMeNowDefaultAction, use value "Block" in XS data mode callMeNowDefaultCallTimeout callMeNowRule applyToAttendedCallTransfers, use value "false" in XS data mode

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 Boolean	applyToAttendedCallTransfers
protected @NotNull CommunicationBarringCallMeNowAction	callMeNowDefaultAction
protected Integer	callMeNowDefaultCallTimeout
protected @Valid CommunicationBarringCallMeNowRule[]	callMeNowRule
protected @Size(min=1,max=80) String	description
protected @NotNull CommunicationBarringIncomingAction	incomingDefaultAction
protected Integer	incomingDefaultCallTimeout
protected @Valid CommunicationBarringIncomingRule19sp1[]	incomingRule
protected @NotNull @Size(min=1,max=40) String	name
protected @NotNull CommunicationBarringOriginatingAction	originatingDefaultAction
protected Integer	originatingDefaultCallTimeout
protected @Size(min=1,max=30) String	originatingDefaultTransferNumber
protected @Size(min=1,max=40) String	originatingDefaultTreatmentId
protected @Valid CommunicationBarringOriginatingRule[]	originatingRule
protected @NotNull CommunicationBarringRedirectingAction	redirectingDefaultAction
protected Integer	redirectingDefaultCallTimeout
protected @Valid CommunicationBarringRedirectingRule[]	redirectingRule

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

log

Constructor Summary

Constructors

Constructor	Description
SystemCommunicationBarringProfileAddRequest()
SystemCommunicationBarringProfileAddRequest(BroadWorksServer broadWorksServer, String name, CommunicationBarringOriginatingAction originatingDefaultAction, CommunicationBarringRedirectingAction redirectingDefaultAction, CommunicationBarringIncomingAction incomingDefaultAction, CommunicationBarringCallMeNowAction callMeNowDefaultAction, Boolean applyToAttendedCallTransfers)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
Boolean	getApplyToAttendedCallTransfers()
CommunicationBarringCallMeNowAction	getCallMeNowDefaultAction()
Integer	getCallMeNowDefaultCallTimeout()
CommunicationBarringCallMeNowRule[]	getCallMeNowRule()
String	getDescription()
static BWSystem.SystemCommunicationBarringProfileAddRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
CommunicationBarringIncomingAction	getIncomingDefaultAction()
Integer	getIncomingDefaultCallTimeout()
CommunicationBarringIncomingRule19sp1[]	getIncomingRule()
String	getName()
CommunicationBarringOriginatingAction	getOriginatingDefaultAction()
Integer	getOriginatingDefaultCallTimeout()
String	getOriginatingDefaultTransferNumber()
String	getOriginatingDefaultTreatmentId()
CommunicationBarringOriginatingRule[]	getOriginatingRule()
CommunicationBarringRedirectingAction	getRedirectingDefaultAction()
Integer	getRedirectingDefaultCallTimeout()
CommunicationBarringRedirectingRule[]	getRedirectingRule()
BWSystem.SystemCommunicationBarringProfileAddRequest	setApplyToAttendedCallTransfers(Boolean applyToAttendedCallTransfers)
BWSystem.SystemCommunicationBarringProfileAddRequest	setCallMeNowDefaultAction(CommunicationBarringCallMeNowAction callMeNowDefaultAction)
BWSystem.SystemCommunicationBarringProfileAddRequest	setCallMeNowDefaultCallTimeout(Integer callMeNowDefaultCallTimeout)
BWSystem.SystemCommunicationBarringProfileAddRequest	setCallMeNowRule(CommunicationBarringCallMeNowRule... callMeNowRule)
BWSystem.SystemCommunicationBarringProfileAddRequest	setDescription(String description)
BWSystem.SystemCommunicationBarringProfileAddRequest	setIncomingDefaultAction(CommunicationBarringIncomingAction incomingDefaultAction)
BWSystem.SystemCommunicationBarringProfileAddRequest	setIncomingDefaultCallTimeout(Integer incomingDefaultCallTimeout)
BWSystem.SystemCommunicationBarringProfileAddRequest	setIncomingRule(CommunicationBarringIncomingRule19sp1... incomingRule)
BWSystem.SystemCommunicationBarringProfileAddRequest	setName(String name)
BWSystem.SystemCommunicationBarringProfileAddRequest	setOriginatingDefaultAction(CommunicationBarringOriginatingAction originatingDefaultAction)
BWSystem.SystemCommunicationBarringProfileAddRequest	setOriginatingDefaultCallTimeout(Integer originatingDefaultCallTimeout)
BWSystem.SystemCommunicationBarringProfileAddRequest	setOriginatingDefaultTransferNumber(String originatingDefaultTransferNumber)
BWSystem.SystemCommunicationBarringProfileAddRequest	setOriginatingDefaultTreatmentId(String originatingDefaultTreatmentId)
BWSystem.SystemCommunicationBarringProfileAddRequest	setOriginatingRule(CommunicationBarringOriginatingRule... originatingRule)
BWSystem.SystemCommunicationBarringProfileAddRequest	setRedirectingDefaultAction(CommunicationBarringRedirectingAction redirectingDefaultAction)
BWSystem.SystemCommunicationBarringProfileAddRequest	setRedirectingDefaultCallTimeout(Integer redirectingDefaultCallTimeout)
BWSystem.SystemCommunicationBarringProfileAddRequest	setRedirectingRule(CommunicationBarringRedirectingRule... redirectingRule)

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

name

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

description

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

originatingDefaultAction

@NotNull
protected @NotNull CommunicationBarringOriginatingAction originatingDefaultAction

originatingDefaultTreatmentId

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

originatingDefaultTransferNumber

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

originatingDefaultCallTimeout

protected Integer originatingDefaultCallTimeout

originatingRule

@Valid
protected @Valid CommunicationBarringOriginatingRule[] originatingRule

redirectingDefaultAction

@NotNull
protected @NotNull CommunicationBarringRedirectingAction redirectingDefaultAction

redirectingDefaultCallTimeout

protected Integer redirectingDefaultCallTimeout

redirectingRule

@Valid
protected @Valid CommunicationBarringRedirectingRule[] redirectingRule

incomingDefaultAction

@NotNull
protected @NotNull CommunicationBarringIncomingAction incomingDefaultAction

incomingDefaultCallTimeout

protected Integer incomingDefaultCallTimeout

incomingRule

@Valid
protected @Valid CommunicationBarringIncomingRule19sp1[] incomingRule

callMeNowDefaultAction

@NotNull
protected @NotNull CommunicationBarringCallMeNowAction callMeNowDefaultAction

callMeNowDefaultCallTimeout

protected Integer callMeNowDefaultCallTimeout

callMeNowRule

@Valid
protected @Valid CommunicationBarringCallMeNowRule[] callMeNowRule

applyToAttendedCallTransfers

@NotNull
protected @NotNull Boolean applyToAttendedCallTransfers

Constructor Detail

SystemCommunicationBarringProfileAddRequest

public SystemCommunicationBarringProfileAddRequest()

SystemCommunicationBarringProfileAddRequest

public SystemCommunicationBarringProfileAddRequest(BroadWorksServer broadWorksServer,
                                                   String name,
                                                   CommunicationBarringOriginatingAction originatingDefaultAction,
                                                   CommunicationBarringRedirectingAction redirectingDefaultAction,
                                                   CommunicationBarringIncomingAction incomingDefaultAction,
                                                   CommunicationBarringCallMeNowAction callMeNowDefaultAction,
                                                   Boolean applyToAttendedCallTransfers)

Method Detail

setName

public BWSystem.SystemCommunicationBarringProfileAddRequest setName(String name)

getName

public String getName()

setDescription

public BWSystem.SystemCommunicationBarringProfileAddRequest setDescription(String description)

getDescription

public String getDescription()

setOriginatingDefaultAction

public BWSystem.SystemCommunicationBarringProfileAddRequest setOriginatingDefaultAction(CommunicationBarringOriginatingAction originatingDefaultAction)

getOriginatingDefaultAction

public CommunicationBarringOriginatingAction getOriginatingDefaultAction()

setOriginatingDefaultTreatmentId

public BWSystem.SystemCommunicationBarringProfileAddRequest setOriginatingDefaultTreatmentId(String originatingDefaultTreatmentId)

getOriginatingDefaultTreatmentId

public String getOriginatingDefaultTreatmentId()

setOriginatingDefaultTransferNumber

public BWSystem.SystemCommunicationBarringProfileAddRequest setOriginatingDefaultTransferNumber(String originatingDefaultTransferNumber)

getOriginatingDefaultTransferNumber

public String getOriginatingDefaultTransferNumber()

setOriginatingDefaultCallTimeout

public BWSystem.SystemCommunicationBarringProfileAddRequest setOriginatingDefaultCallTimeout(Integer originatingDefaultCallTimeout)

getOriginatingDefaultCallTimeout

public Integer getOriginatingDefaultCallTimeout()

setOriginatingRule

public BWSystem.SystemCommunicationBarringProfileAddRequest setOriginatingRule(CommunicationBarringOriginatingRule... originatingRule)

getOriginatingRule

public CommunicationBarringOriginatingRule[] getOriginatingRule()

setRedirectingDefaultAction

public BWSystem.SystemCommunicationBarringProfileAddRequest setRedirectingDefaultAction(CommunicationBarringRedirectingAction redirectingDefaultAction)

getRedirectingDefaultAction

public CommunicationBarringRedirectingAction getRedirectingDefaultAction()

setRedirectingDefaultCallTimeout

public BWSystem.SystemCommunicationBarringProfileAddRequest setRedirectingDefaultCallTimeout(Integer redirectingDefaultCallTimeout)

getRedirectingDefaultCallTimeout

public Integer getRedirectingDefaultCallTimeout()

setRedirectingRule

public BWSystem.SystemCommunicationBarringProfileAddRequest setRedirectingRule(CommunicationBarringRedirectingRule... redirectingRule)

getRedirectingRule

public CommunicationBarringRedirectingRule[] getRedirectingRule()

setIncomingDefaultAction

public BWSystem.SystemCommunicationBarringProfileAddRequest setIncomingDefaultAction(CommunicationBarringIncomingAction incomingDefaultAction)

getIncomingDefaultAction

public CommunicationBarringIncomingAction getIncomingDefaultAction()

setIncomingDefaultCallTimeout

public BWSystem.SystemCommunicationBarringProfileAddRequest setIncomingDefaultCallTimeout(Integer incomingDefaultCallTimeout)

getIncomingDefaultCallTimeout

public Integer getIncomingDefaultCallTimeout()

setIncomingRule

public BWSystem.SystemCommunicationBarringProfileAddRequest setIncomingRule(CommunicationBarringIncomingRule19sp1... incomingRule)

getIncomingRule

public CommunicationBarringIncomingRule19sp1[] getIncomingRule()

setCallMeNowDefaultAction

public BWSystem.SystemCommunicationBarringProfileAddRequest setCallMeNowDefaultAction(CommunicationBarringCallMeNowAction callMeNowDefaultAction)

getCallMeNowDefaultAction

public CommunicationBarringCallMeNowAction getCallMeNowDefaultAction()

setCallMeNowDefaultCallTimeout

public BWSystem.SystemCommunicationBarringProfileAddRequest setCallMeNowDefaultCallTimeout(Integer callMeNowDefaultCallTimeout)

getCallMeNowDefaultCallTimeout

public Integer getCallMeNowDefaultCallTimeout()

setCallMeNowRule

public BWSystem.SystemCommunicationBarringProfileAddRequest setCallMeNowRule(CommunicationBarringCallMeNowRule... callMeNowRule)

getCallMeNowRule

public CommunicationBarringCallMeNowRule[] getCallMeNowRule()

setApplyToAttendedCallTransfers

public BWSystem.SystemCommunicationBarringProfileAddRequest setApplyToAttendedCallTransfers(Boolean applyToAttendedCallTransfers)

getApplyToAttendedCallTransfers

public Boolean getApplyToAttendedCallTransfers()

getEmptyObject

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