Package co.ecg.alpaca.toolkit.generated

Class ServiceProvider.ServiceProviderCommunicationBarringProfileAddRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.ServiceProvider.ServiceProviderCommunicationBarringProfileAddRequest

Enclosing class:

ServiceProvider

public static class ServiceProvider.ServiceProviderCommunicationBarringProfileAddRequest
extends Request<DefaultResponse>

Add a new Communication Barring Profile. The priorities for OriginatingRules, RedirectingRules, CallMeNowRules and 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 Boolean	becomeDefault
protected @NotNull CommunicationBarringCallMeNowAction	callMeNowDefaultAction
protected Integer	callMeNowDefaultCallTimeout
protected @Valid ServiceProviderCommunicationBarringHierarchicalCallMeNowRule[]	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 ServiceProviderCommunicationBarringHierarchicalOriginatingRule[]	originatingRule
protected @NotNull CommunicationBarringRedirectingAction	redirectingDefaultAction
protected Integer	redirectingDefaultCallTimeout
protected @Valid ServiceProviderCommunicationBarringHierarchicalRedirectingRule[]	redirectingRule
protected @NotNull @Valid ServiceProvider	serviceProvider

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

log

Constructor Summary

Constructors

Constructor	Description
ServiceProviderCommunicationBarringProfileAddRequest()
ServiceProviderCommunicationBarringProfileAddRequest(ServiceProvider serviceProvider, String name, CommunicationBarringOriginatingAction originatingDefaultAction, CommunicationBarringRedirectingAction redirectingDefaultAction, CommunicationBarringCallMeNowAction callMeNowDefaultAction, CommunicationBarringIncomingAction incomingDefaultAction, Boolean becomeDefault, Boolean applyToAttendedCallTransfers)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
Boolean	getApplyToAttendedCallTransfers()
Boolean	getBecomeDefault()
CommunicationBarringCallMeNowAction	getCallMeNowDefaultAction()
Integer	getCallMeNowDefaultCallTimeout()
ServiceProviderCommunicationBarringHierarchicalCallMeNowRule[]	getCallMeNowRule()
String	getDescription()
static ServiceProvider.ServiceProviderCommunicationBarringProfileAddRequest	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()
ServiceProviderCommunicationBarringHierarchicalOriginatingRule[]	getOriginatingRule()
CommunicationBarringRedirectingAction	getRedirectingDefaultAction()
Integer	getRedirectingDefaultCallTimeout()
ServiceProviderCommunicationBarringHierarchicalRedirectingRule[]	getRedirectingRule()
ServiceProvider	getServiceProvider()
ServiceProvider.ServiceProviderCommunicationBarringProfileAddRequest	setApplyToAttendedCallTransfers(Boolean applyToAttendedCallTransfers)
ServiceProvider.ServiceProviderCommunicationBarringProfileAddRequest	setBecomeDefault(Boolean becomeDefault)
ServiceProvider.ServiceProviderCommunicationBarringProfileAddRequest	setCallMeNowDefaultAction(CommunicationBarringCallMeNowAction callMeNowDefaultAction)
ServiceProvider.ServiceProviderCommunicationBarringProfileAddRequest	setCallMeNowDefaultCallTimeout(Integer callMeNowDefaultCallTimeout)
ServiceProvider.ServiceProviderCommunicationBarringProfileAddRequest	setCallMeNowRule(ServiceProviderCommunicationBarringHierarchicalCallMeNowRule... callMeNowRule)
ServiceProvider.ServiceProviderCommunicationBarringProfileAddRequest	setDescription(String description)
ServiceProvider.ServiceProviderCommunicationBarringProfileAddRequest	setIncomingDefaultAction(CommunicationBarringIncomingAction incomingDefaultAction)
ServiceProvider.ServiceProviderCommunicationBarringProfileAddRequest	setIncomingDefaultCallTimeout(Integer incomingDefaultCallTimeout)
ServiceProvider.ServiceProviderCommunicationBarringProfileAddRequest	setIncomingRule(CommunicationBarringIncomingRule19sp1... incomingRule)
ServiceProvider.ServiceProviderCommunicationBarringProfileAddRequest	setName(String name)
ServiceProvider.ServiceProviderCommunicationBarringProfileAddRequest	setOriginatingDefaultAction(CommunicationBarringOriginatingAction originatingDefaultAction)
ServiceProvider.ServiceProviderCommunicationBarringProfileAddRequest	setOriginatingDefaultCallTimeout(Integer originatingDefaultCallTimeout)
ServiceProvider.ServiceProviderCommunicationBarringProfileAddRequest	setOriginatingDefaultTransferNumber(String originatingDefaultTransferNumber)
ServiceProvider.ServiceProviderCommunicationBarringProfileAddRequest	setOriginatingDefaultTreatmentId(String originatingDefaultTreatmentId)
ServiceProvider.ServiceProviderCommunicationBarringProfileAddRequest	setOriginatingRule(ServiceProviderCommunicationBarringHierarchicalOriginatingRule... originatingRule)
ServiceProvider.ServiceProviderCommunicationBarringProfileAddRequest	setRedirectingDefaultAction(CommunicationBarringRedirectingAction redirectingDefaultAction)
ServiceProvider.ServiceProviderCommunicationBarringProfileAddRequest	setRedirectingDefaultCallTimeout(Integer redirectingDefaultCallTimeout)
ServiceProvider.ServiceProviderCommunicationBarringProfileAddRequest	setRedirectingRule(ServiceProviderCommunicationBarringHierarchicalRedirectingRule... redirectingRule)
ServiceProvider.ServiceProviderCommunicationBarringProfileAddRequest	setServiceProvider(ServiceProvider serviceProvider)

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

serviceProvider

@NotNull
@Valid
protected transient @NotNull @Valid ServiceProvider serviceProvider

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 ServiceProviderCommunicationBarringHierarchicalOriginatingRule[] originatingRule

redirectingDefaultAction

@NotNull
protected @NotNull CommunicationBarringRedirectingAction redirectingDefaultAction

redirectingDefaultCallTimeout

protected Integer redirectingDefaultCallTimeout

redirectingRule

@Valid
protected @Valid ServiceProviderCommunicationBarringHierarchicalRedirectingRule[] redirectingRule

callMeNowDefaultAction

@NotNull
protected @NotNull CommunicationBarringCallMeNowAction callMeNowDefaultAction

callMeNowDefaultCallTimeout

protected Integer callMeNowDefaultCallTimeout

callMeNowRule

@Valid
protected @Valid ServiceProviderCommunicationBarringHierarchicalCallMeNowRule[] callMeNowRule

incomingDefaultAction

@NotNull
protected @NotNull CommunicationBarringIncomingAction incomingDefaultAction

incomingDefaultCallTimeout

protected Integer incomingDefaultCallTimeout

incomingRule

@Valid
protected @Valid CommunicationBarringIncomingRule19sp1[] incomingRule

becomeDefault

@NotNull
protected @NotNull Boolean becomeDefault

applyToAttendedCallTransfers

@NotNull
protected @NotNull Boolean applyToAttendedCallTransfers

Constructor Details

ServiceProviderCommunicationBarringProfileAddRequest

public ServiceProviderCommunicationBarringProfileAddRequest()

ServiceProviderCommunicationBarringProfileAddRequest

public ServiceProviderCommunicationBarringProfileAddRequest(ServiceProvider serviceProvider,
 String name,
 CommunicationBarringOriginatingAction originatingDefaultAction,
 CommunicationBarringRedirectingAction redirectingDefaultAction,
 CommunicationBarringCallMeNowAction callMeNowDefaultAction,
 CommunicationBarringIncomingAction incomingDefaultAction,
 Boolean becomeDefault,
 Boolean applyToAttendedCallTransfers)

Method Details

setServiceProvider

public ServiceProvider.ServiceProviderCommunicationBarringProfileAddRequest setServiceProvider(ServiceProvider serviceProvider)

getServiceProvider

public ServiceProvider getServiceProvider()

setName

public ServiceProvider.ServiceProviderCommunicationBarringProfileAddRequest setName(String name)

getName

public String getName()

setDescription

public ServiceProvider.ServiceProviderCommunicationBarringProfileAddRequest setDescription(String description)

getDescription

public String getDescription()

setOriginatingDefaultAction

public ServiceProvider.ServiceProviderCommunicationBarringProfileAddRequest setOriginatingDefaultAction(CommunicationBarringOriginatingAction originatingDefaultAction)

getOriginatingDefaultAction

public CommunicationBarringOriginatingAction getOriginatingDefaultAction()

setOriginatingDefaultTreatmentId

public ServiceProvider.ServiceProviderCommunicationBarringProfileAddRequest setOriginatingDefaultTreatmentId(String originatingDefaultTreatmentId)

getOriginatingDefaultTreatmentId

public String getOriginatingDefaultTreatmentId()

setOriginatingDefaultTransferNumber

public ServiceProvider.ServiceProviderCommunicationBarringProfileAddRequest setOriginatingDefaultTransferNumber(String originatingDefaultTransferNumber)

getOriginatingDefaultTransferNumber

public String getOriginatingDefaultTransferNumber()

setOriginatingDefaultCallTimeout

public ServiceProvider.ServiceProviderCommunicationBarringProfileAddRequest setOriginatingDefaultCallTimeout(Integer originatingDefaultCallTimeout)

getOriginatingDefaultCallTimeout

public Integer getOriginatingDefaultCallTimeout()

setOriginatingRule

public ServiceProvider.ServiceProviderCommunicationBarringProfileAddRequest setOriginatingRule(ServiceProviderCommunicationBarringHierarchicalOriginatingRule... originatingRule)

getOriginatingRule

public ServiceProviderCommunicationBarringHierarchicalOriginatingRule[] getOriginatingRule()

setRedirectingDefaultAction

public ServiceProvider.ServiceProviderCommunicationBarringProfileAddRequest setRedirectingDefaultAction(CommunicationBarringRedirectingAction redirectingDefaultAction)

getRedirectingDefaultAction

public CommunicationBarringRedirectingAction getRedirectingDefaultAction()

setRedirectingDefaultCallTimeout

public ServiceProvider.ServiceProviderCommunicationBarringProfileAddRequest setRedirectingDefaultCallTimeout(Integer redirectingDefaultCallTimeout)

getRedirectingDefaultCallTimeout

public Integer getRedirectingDefaultCallTimeout()

setRedirectingRule

public ServiceProvider.ServiceProviderCommunicationBarringProfileAddRequest setRedirectingRule(ServiceProviderCommunicationBarringHierarchicalRedirectingRule... redirectingRule)

getRedirectingRule

public ServiceProviderCommunicationBarringHierarchicalRedirectingRule[] getRedirectingRule()

setCallMeNowDefaultAction

public ServiceProvider.ServiceProviderCommunicationBarringProfileAddRequest setCallMeNowDefaultAction(CommunicationBarringCallMeNowAction callMeNowDefaultAction)

getCallMeNowDefaultAction

public CommunicationBarringCallMeNowAction getCallMeNowDefaultAction()

setCallMeNowDefaultCallTimeout

public ServiceProvider.ServiceProviderCommunicationBarringProfileAddRequest setCallMeNowDefaultCallTimeout(Integer callMeNowDefaultCallTimeout)

getCallMeNowDefaultCallTimeout

public Integer getCallMeNowDefaultCallTimeout()

setCallMeNowRule

public ServiceProvider.ServiceProviderCommunicationBarringProfileAddRequest setCallMeNowRule(ServiceProviderCommunicationBarringHierarchicalCallMeNowRule... callMeNowRule)

getCallMeNowRule

public ServiceProviderCommunicationBarringHierarchicalCallMeNowRule[] getCallMeNowRule()

setIncomingDefaultAction

public ServiceProvider.ServiceProviderCommunicationBarringProfileAddRequest setIncomingDefaultAction(CommunicationBarringIncomingAction incomingDefaultAction)

getIncomingDefaultAction

public CommunicationBarringIncomingAction getIncomingDefaultAction()

setIncomingDefaultCallTimeout

public ServiceProvider.ServiceProviderCommunicationBarringProfileAddRequest setIncomingDefaultCallTimeout(Integer incomingDefaultCallTimeout)

getIncomingDefaultCallTimeout

public Integer getIncomingDefaultCallTimeout()

setIncomingRule

public ServiceProvider.ServiceProviderCommunicationBarringProfileAddRequest setIncomingRule(CommunicationBarringIncomingRule19sp1... incomingRule)

getIncomingRule

public CommunicationBarringIncomingRule19sp1[] getIncomingRule()

setBecomeDefault

public ServiceProvider.ServiceProviderCommunicationBarringProfileAddRequest setBecomeDefault(Boolean becomeDefault)

getBecomeDefault

public Boolean getBecomeDefault()

setApplyToAttendedCallTransfers

public ServiceProvider.ServiceProviderCommunicationBarringProfileAddRequest setApplyToAttendedCallTransfers(Boolean applyToAttendedCallTransfers)

getApplyToAttendedCallTransfers

public Boolean getApplyToAttendedCallTransfers()

getEmptyObject

public static ServiceProvider.ServiceProviderCommunicationBarringProfileAddRequest 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>