Package co.ecg.alpaca.toolkit.generated

Class BWSystem.SystemSystemVoicePortalAddRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.BWSystem.SystemSystemVoicePortalAddRequest

Enclosing class:

BWSystem

public static class BWSystem.SystemSystemVoicePortalAddRequest
extends Request<DefaultResponse>

Request to add a system voice portal instance. The response is either SuccessResponse or ErrorResponse. The following elements are only used in IMS mode: publicUserIdentity, ignored in standalone mode if provided. The following elements are only used in AS mode and ignored in XS data mode: networkClassOfService

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	allowIdentificationByPhoneNumberOrVoiceMailAliasesOnLogin
protected @NotNull @Size(min=1,max=80) String	callingLineIdName
protected @NotNull Boolean	expressMode
protected @NotNull @Size(min=1,max=40) String	language
protected @NotNull @Size(min=1,max=80) String	name
protected @Size(min=1,max=40) String	networkClassOfService
protected @Size(min=1,max=23) String	networkVoicePortalNumber
protected @Size(min=1,max=23) String	phoneNumber
protected @Size(min=1,max=161) String	publicUserIdentity
protected @NotNull @Size(min=1,max=161) String	systemVoicePortalId
protected @NotNull @Size(min=1,max=127) String	timeZone
protected @NotNull Boolean	useVoiceMessagingDefaultGreeting
protected @NotNull Boolean	useVoicePortalDefaultGreeting
protected @NotNull Boolean	useVoicePortalWizard
protected @Valid LabeledMediaFileResource	voiceMessagingGreetingFile
protected @Valid LabeledMediaFileResource	voicePortalGreetingFile

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

log

Constructor Summary

Constructors

Constructor	Description
SystemSystemVoicePortalAddRequest()
SystemSystemVoicePortalAddRequest(BroadWorksServer broadWorksServer, String systemVoicePortalId, String name, String callingLineIdName, String language, String timeZone, Boolean allowIdentificationByPhoneNumberOrVoiceMailAliasesOnLogin, Boolean useVoicePortalWizard, Boolean useVoicePortalDefaultGreeting, Boolean useVoiceMessagingDefaultGreeting, Boolean expressMode)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
Boolean	getAllowIdentificationByPhoneNumberOrVoiceMailAliasesOnLogin()
String	getCallingLineIdName()
static BWSystem.SystemSystemVoicePortalAddRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
Boolean	getExpressMode()
String	getLanguage()
String	getName()
String	getNetworkClassOfService()
String	getNetworkVoicePortalNumber()
String	getPhoneNumber()
String	getPublicUserIdentity()
String	getSystemVoicePortalId()
String	getTimeZone()
Boolean	getUseVoiceMessagingDefaultGreeting()
Boolean	getUseVoicePortalDefaultGreeting()
Boolean	getUseVoicePortalWizard()
LabeledMediaFileResource	getVoiceMessagingGreetingFile()
LabeledMediaFileResource	getVoicePortalGreetingFile()
BWSystem.SystemSystemVoicePortalAddRequest	setAllowIdentificationByPhoneNumberOrVoiceMailAliasesOnLogin(Boolean allowIdentificationByPhoneNumberOrVoiceMailAliasesOnLogin)
BWSystem.SystemSystemVoicePortalAddRequest	setCallingLineIdName(String callingLineIdName)
BWSystem.SystemSystemVoicePortalAddRequest	setExpressMode(Boolean expressMode)
BWSystem.SystemSystemVoicePortalAddRequest	setLanguage(String language)
BWSystem.SystemSystemVoicePortalAddRequest	setName(String name)
BWSystem.SystemSystemVoicePortalAddRequest	setNetworkClassOfService(String networkClassOfService)
BWSystem.SystemSystemVoicePortalAddRequest	setNetworkVoicePortalNumber(String networkVoicePortalNumber)
BWSystem.SystemSystemVoicePortalAddRequest	setPhoneNumber(String phoneNumber)
BWSystem.SystemSystemVoicePortalAddRequest	setPublicUserIdentity(String publicUserIdentity)
BWSystem.SystemSystemVoicePortalAddRequest	setSystemVoicePortalId(String systemVoicePortalId)
BWSystem.SystemSystemVoicePortalAddRequest	setTimeZone(String timeZone)
BWSystem.SystemSystemVoicePortalAddRequest	setUseVoiceMessagingDefaultGreeting(Boolean useVoiceMessagingDefaultGreeting)
BWSystem.SystemSystemVoicePortalAddRequest	setUseVoicePortalDefaultGreeting(Boolean useVoicePortalDefaultGreeting)
BWSystem.SystemSystemVoicePortalAddRequest	setUseVoicePortalWizard(Boolean useVoicePortalWizard)
BWSystem.SystemSystemVoicePortalAddRequest	setVoiceMessagingGreetingFile(LabeledMediaFileResource voiceMessagingGreetingFile)
BWSystem.SystemSystemVoicePortalAddRequest	setVoicePortalGreetingFile(LabeledMediaFileResource voicePortalGreetingFile)

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

systemVoicePortalId

@NotNull
@Size(min=1,
      max=161)
protected @NotNull @Size(min=1,max=161) String systemVoicePortalId

name

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

callingLineIdName

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

language

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

timeZone

@NotNull
@Size(min=1,
      max=127)
protected @NotNull @Size(min=1,max=127) String timeZone

phoneNumber

@Size(min=1,
      max=23)
protected @Size(min=1,max=23) String phoneNumber

publicUserIdentity

@Pattern(regexp="[a-zA-Z0-9._!~*\'()+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,4}")
@Size(min=1,
      max=161)
protected @Size(min=1,max=161) String publicUserIdentity

networkVoicePortalNumber

@Size(min=1,
      max=23)
protected @Size(min=1,max=23) String networkVoicePortalNumber

allowIdentificationByPhoneNumberOrVoiceMailAliasesOnLogin

@NotNull
protected @NotNull Boolean allowIdentificationByPhoneNumberOrVoiceMailAliasesOnLogin

useVoicePortalWizard

@NotNull
protected @NotNull Boolean useVoicePortalWizard

useVoicePortalDefaultGreeting

@NotNull
protected @NotNull Boolean useVoicePortalDefaultGreeting

voicePortalGreetingFile

@Valid
protected @Valid LabeledMediaFileResource voicePortalGreetingFile

useVoiceMessagingDefaultGreeting

@NotNull
protected @NotNull Boolean useVoiceMessagingDefaultGreeting

voiceMessagingGreetingFile

@Valid
protected @Valid LabeledMediaFileResource voiceMessagingGreetingFile

expressMode

@NotNull
protected @NotNull Boolean expressMode

networkClassOfService

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

Constructor Details

SystemSystemVoicePortalAddRequest

public SystemSystemVoicePortalAddRequest()

SystemSystemVoicePortalAddRequest

public SystemSystemVoicePortalAddRequest(BroadWorksServer broadWorksServer,
 String systemVoicePortalId,
 String name,
 String callingLineIdName,
 String language,
 String timeZone,
 Boolean allowIdentificationByPhoneNumberOrVoiceMailAliasesOnLogin,
 Boolean useVoicePortalWizard,
 Boolean useVoicePortalDefaultGreeting,
 Boolean useVoiceMessagingDefaultGreeting,
 Boolean expressMode)

Method Details

setSystemVoicePortalId

public BWSystem.SystemSystemVoicePortalAddRequest setSystemVoicePortalId(String systemVoicePortalId)

getSystemVoicePortalId

public String getSystemVoicePortalId()

setName

public BWSystem.SystemSystemVoicePortalAddRequest setName(String name)

getName

public String getName()

setCallingLineIdName

public BWSystem.SystemSystemVoicePortalAddRequest setCallingLineIdName(String callingLineIdName)

getCallingLineIdName

public String getCallingLineIdName()

setLanguage

public BWSystem.SystemSystemVoicePortalAddRequest setLanguage(String language)

getLanguage

public String getLanguage()

setTimeZone

public BWSystem.SystemSystemVoicePortalAddRequest setTimeZone(String timeZone)

getTimeZone

public String getTimeZone()

setPhoneNumber

public BWSystem.SystemSystemVoicePortalAddRequest setPhoneNumber(String phoneNumber)

getPhoneNumber

public String getPhoneNumber()

setPublicUserIdentity

public BWSystem.SystemSystemVoicePortalAddRequest setPublicUserIdentity(String publicUserIdentity)

getPublicUserIdentity

public String getPublicUserIdentity()

setNetworkVoicePortalNumber

public BWSystem.SystemSystemVoicePortalAddRequest setNetworkVoicePortalNumber(String networkVoicePortalNumber)

getNetworkVoicePortalNumber

public String getNetworkVoicePortalNumber()

setAllowIdentificationByPhoneNumberOrVoiceMailAliasesOnLogin

public BWSystem.SystemSystemVoicePortalAddRequest setAllowIdentificationByPhoneNumberOrVoiceMailAliasesOnLogin(Boolean allowIdentificationByPhoneNumberOrVoiceMailAliasesOnLogin)

getAllowIdentificationByPhoneNumberOrVoiceMailAliasesOnLogin

public Boolean getAllowIdentificationByPhoneNumberOrVoiceMailAliasesOnLogin()

setUseVoicePortalWizard

public BWSystem.SystemSystemVoicePortalAddRequest setUseVoicePortalWizard(Boolean useVoicePortalWizard)

getUseVoicePortalWizard

public Boolean getUseVoicePortalWizard()

setUseVoicePortalDefaultGreeting

public BWSystem.SystemSystemVoicePortalAddRequest setUseVoicePortalDefaultGreeting(Boolean useVoicePortalDefaultGreeting)

getUseVoicePortalDefaultGreeting

public Boolean getUseVoicePortalDefaultGreeting()

setVoicePortalGreetingFile

public BWSystem.SystemSystemVoicePortalAddRequest setVoicePortalGreetingFile(LabeledMediaFileResource voicePortalGreetingFile)

getVoicePortalGreetingFile

public LabeledMediaFileResource getVoicePortalGreetingFile()

setUseVoiceMessagingDefaultGreeting

public BWSystem.SystemSystemVoicePortalAddRequest setUseVoiceMessagingDefaultGreeting(Boolean useVoiceMessagingDefaultGreeting)

getUseVoiceMessagingDefaultGreeting

public Boolean getUseVoiceMessagingDefaultGreeting()

setVoiceMessagingGreetingFile

public BWSystem.SystemSystemVoicePortalAddRequest setVoiceMessagingGreetingFile(LabeledMediaFileResource voiceMessagingGreetingFile)

getVoiceMessagingGreetingFile

public LabeledMediaFileResource getVoiceMessagingGreetingFile()

setExpressMode

public BWSystem.SystemSystemVoicePortalAddRequest setExpressMode(Boolean expressMode)

getExpressMode

public Boolean getExpressMode()

setNetworkClassOfService

public BWSystem.SystemSystemVoicePortalAddRequest setNetworkClassOfService(String networkClassOfService)

getNetworkClassOfService

public String getNetworkClassOfService()

getEmptyObject

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