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

Class GroupVoiceMessaging.GroupVoiceMessagingGroupConsolidatedModifyVoicePortalRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.services.GroupVoiceMessaging.GroupVoiceMessagingGroupConsolidatedModifyVoicePortalRequest

Enclosing class:

GroupVoiceMessaging

public static class GroupVoiceMessaging.GroupVoiceMessagingGroupConsolidatedModifyVoicePortalRequest
extends Request<DefaultResponse>

Request to modify the group's voice messaging settings and voice portal branding settings. If UnassignPhoneNumbersLevel is set to 'Group', the user's primary phone number, fax number and any alternate numbers, will be un-assigned from the group if the command is executed by a service provider administrator or above. When set to 'Service Provider', they will be un-assigned from the group and service provider if the command is executed by a provisioning administrator or above. When omitted, the number(s) will be left assigned to the group. An ErrorResponse will be returned if any number cannot be unassigned because of insufficient privilege. The response is either SuccessResponse or ErrorResponse.

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 @AssertTrue Boolean	addPhoneNumberToGroup
protected Boolean	allowIdentificationByPhoneNumberOrVoiceMailAliasesOnLogin
protected Boolean	enableExtendedScope
protected Optional<@Size(min=1,max=161) String>	externalRoutingAddress
protected @NotNull @Valid Group	group
protected Optional<@Size(min=1,max=80) String>	homeZoneName
protected Boolean	isActive
protected @Size(min=1,max=40) String	networkClassOfService
protected @Valid ServiceInstanceModifyProfile	serviceInstanceProfile
protected UnassignPhoneNumbersLevel	unassignPhoneNumbers
protected Boolean	useExternalRouting
protected Boolean	useVoicePortalWizard
protected Optional<@Valid AnnouncementFileKey>	voiceMessagingGreetingFile
protected VoiceMessagingBrandingSelection	voiceMessagingGreetingSelection
protected VoicePortalExternalRoutingScope	voicePortalExternalRoutingScope
protected Optional<@Valid AnnouncementFileKey>	voicePortalGreetingFile
protected VoiceMessagingBrandingSelection	voicePortalGreetingSelection

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

log

Constructor Summary

Constructors

Constructor	Description
GroupVoiceMessagingGroupConsolidatedModifyVoicePortalRequest()
GroupVoiceMessagingGroupConsolidatedModifyVoicePortalRequest(Group group)

Method Summary

Modifier and Type	Method	Description
boolean	addPhoneNumberToGroupFlagExist()
void	formRequest()	Forms the XML Document for this Request Object.
Boolean	getAddPhoneNumberToGroup()
Boolean	getAllowIdentificationByPhoneNumberOrVoiceMailAliasesOnLogin()
static GroupVoiceMessaging.GroupVoiceMessagingGroupConsolidatedModifyVoicePortalRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
Boolean	getEnableExtendedScope()
Optional<@Size(min=1,max=161) String>	getExternalRoutingAddress()
Group	getGroup()
Optional<@Size(min=1,max=80) String>	getHomeZoneName()
Boolean	getIsActive()
String	getNetworkClassOfService()
ServiceInstanceModifyProfile	getServiceInstanceProfile()
UnassignPhoneNumbersLevel	getUnassignPhoneNumbers()
Boolean	getUseExternalRouting()
Boolean	getUseVoicePortalWizard()
Optional<@Valid AnnouncementFileKey>	getVoiceMessagingGreetingFile()
VoiceMessagingBrandingSelection	getVoiceMessagingGreetingSelection()
VoicePortalExternalRoutingScope	getVoicePortalExternalRoutingScope()
Optional<@Valid AnnouncementFileKey>	getVoicePortalGreetingFile()
VoiceMessagingBrandingSelection	getVoicePortalGreetingSelection()
GroupVoiceMessaging.GroupVoiceMessagingGroupConsolidatedModifyVoicePortalRequest	setAllowIdentificationByPhoneNumberOrVoiceMailAliasesOnLogin(Boolean allowIdentificationByPhoneNumberOrVoiceMailAliasesOnLogin)
GroupVoiceMessaging.GroupVoiceMessagingGroupConsolidatedModifyVoicePortalRequest	setEnableExtendedScope(Boolean enableExtendedScope)
GroupVoiceMessaging.GroupVoiceMessagingGroupConsolidatedModifyVoicePortalRequest	setExternalRoutingAddress(String externalRoutingAddress)
GroupVoiceMessaging.GroupVoiceMessagingGroupConsolidatedModifyVoicePortalRequest	setFlagAddPhoneNumberToGroup()
GroupVoiceMessaging.GroupVoiceMessagingGroupConsolidatedModifyVoicePortalRequest	setGroup(Group group)
GroupVoiceMessaging.GroupVoiceMessagingGroupConsolidatedModifyVoicePortalRequest	setHomeZoneName(String homeZoneName)
GroupVoiceMessaging.GroupVoiceMessagingGroupConsolidatedModifyVoicePortalRequest	setIsActive(Boolean isActive)
GroupVoiceMessaging.GroupVoiceMessagingGroupConsolidatedModifyVoicePortalRequest	setNetworkClassOfService(String networkClassOfService)
GroupVoiceMessaging.GroupVoiceMessagingGroupConsolidatedModifyVoicePortalRequest	setServiceInstanceProfile(ServiceInstanceModifyProfile serviceInstanceProfile)
GroupVoiceMessaging.GroupVoiceMessagingGroupConsolidatedModifyVoicePortalRequest	setUnassignPhoneNumbers(UnassignPhoneNumbersLevel unassignPhoneNumbers)
GroupVoiceMessaging.GroupVoiceMessagingGroupConsolidatedModifyVoicePortalRequest	setUseExternalRouting(Boolean useExternalRouting)
GroupVoiceMessaging.GroupVoiceMessagingGroupConsolidatedModifyVoicePortalRequest	setUseVoicePortalWizard(Boolean useVoicePortalWizard)
GroupVoiceMessaging.GroupVoiceMessagingGroupConsolidatedModifyVoicePortalRequest	setVoiceMessagingGreetingFile(AnnouncementFileKey voiceMessagingGreetingFile)
GroupVoiceMessaging.GroupVoiceMessagingGroupConsolidatedModifyVoicePortalRequest	setVoiceMessagingGreetingSelection(VoiceMessagingBrandingSelection voiceMessagingGreetingSelection)
GroupVoiceMessaging.GroupVoiceMessagingGroupConsolidatedModifyVoicePortalRequest	setVoicePortalExternalRoutingScope(VoicePortalExternalRoutingScope voicePortalExternalRoutingScope)
GroupVoiceMessaging.GroupVoiceMessagingGroupConsolidatedModifyVoicePortalRequest	setVoicePortalGreetingFile(AnnouncementFileKey voicePortalGreetingFile)
GroupVoiceMessaging.GroupVoiceMessagingGroupConsolidatedModifyVoicePortalRequest	setVoicePortalGreetingSelection(VoiceMessagingBrandingSelection voicePortalGreetingSelection)
GroupVoiceMessaging.GroupVoiceMessagingGroupConsolidatedModifyVoicePortalRequest	unsetExternalRoutingAddress()
GroupVoiceMessaging.GroupVoiceMessagingGroupConsolidatedModifyVoicePortalRequest	unsetHomeZoneName()
GroupVoiceMessaging.GroupVoiceMessagingGroupConsolidatedModifyVoicePortalRequest	unsetVoiceMessagingGreetingFile()
GroupVoiceMessaging.GroupVoiceMessagingGroupConsolidatedModifyVoicePortalRequest	unsetVoicePortalGreetingFile()

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

group

@NotNull
@Valid
protected transient @NotNull @Valid Group group

unassignPhoneNumbers

protected UnassignPhoneNumbersLevel unassignPhoneNumbers

addPhoneNumberToGroup

@AssertTrue
protected @AssertTrue Boolean addPhoneNumberToGroup

serviceInstanceProfile

@Valid
protected @Valid ServiceInstanceModifyProfile serviceInstanceProfile

isActive

protected Boolean isActive

enableExtendedScope

protected Boolean enableExtendedScope

allowIdentificationByPhoneNumberOrVoiceMailAliasesOnLogin

protected Boolean allowIdentificationByPhoneNumberOrVoiceMailAliasesOnLogin

useVoicePortalWizard

protected Boolean useVoicePortalWizard

voicePortalExternalRoutingScope

protected VoicePortalExternalRoutingScope voicePortalExternalRoutingScope

useExternalRouting

protected Boolean useExternalRouting

externalRoutingAddress

protected Optional<@Size(min=1,max=161) String> externalRoutingAddress

homeZoneName

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

networkClassOfService

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

voicePortalGreetingSelection

protected VoiceMessagingBrandingSelection voicePortalGreetingSelection

voicePortalGreetingFile

protected Optional<@Valid AnnouncementFileKey> voicePortalGreetingFile

voiceMessagingGreetingSelection

protected VoiceMessagingBrandingSelection voiceMessagingGreetingSelection

voiceMessagingGreetingFile

protected Optional<@Valid AnnouncementFileKey> voiceMessagingGreetingFile

Constructor Detail

GroupVoiceMessagingGroupConsolidatedModifyVoicePortalRequest

public GroupVoiceMessagingGroupConsolidatedModifyVoicePortalRequest()

GroupVoiceMessagingGroupConsolidatedModifyVoicePortalRequest

public GroupVoiceMessagingGroupConsolidatedModifyVoicePortalRequest(Group group)

Method Detail

setGroup

public GroupVoiceMessaging.GroupVoiceMessagingGroupConsolidatedModifyVoicePortalRequest setGroup(Group group)

getGroup

public Group getGroup()

setUnassignPhoneNumbers

public GroupVoiceMessaging.GroupVoiceMessagingGroupConsolidatedModifyVoicePortalRequest setUnassignPhoneNumbers(UnassignPhoneNumbersLevel unassignPhoneNumbers)

getUnassignPhoneNumbers

public UnassignPhoneNumbersLevel getUnassignPhoneNumbers()

setFlagAddPhoneNumberToGroup

public GroupVoiceMessaging.GroupVoiceMessagingGroupConsolidatedModifyVoicePortalRequest setFlagAddPhoneNumberToGroup()

addPhoneNumberToGroupFlagExist

public boolean addPhoneNumberToGroupFlagExist()

getAddPhoneNumberToGroup

public Boolean getAddPhoneNumberToGroup()

setServiceInstanceProfile

public GroupVoiceMessaging.GroupVoiceMessagingGroupConsolidatedModifyVoicePortalRequest setServiceInstanceProfile(ServiceInstanceModifyProfile serviceInstanceProfile)

getServiceInstanceProfile

public ServiceInstanceModifyProfile getServiceInstanceProfile()

setIsActive

public GroupVoiceMessaging.GroupVoiceMessagingGroupConsolidatedModifyVoicePortalRequest setIsActive(Boolean isActive)

getIsActive

public Boolean getIsActive()

setEnableExtendedScope

public GroupVoiceMessaging.GroupVoiceMessagingGroupConsolidatedModifyVoicePortalRequest setEnableExtendedScope(Boolean enableExtendedScope)

getEnableExtendedScope

public Boolean getEnableExtendedScope()

setAllowIdentificationByPhoneNumberOrVoiceMailAliasesOnLogin

public GroupVoiceMessaging.GroupVoiceMessagingGroupConsolidatedModifyVoicePortalRequest setAllowIdentificationByPhoneNumberOrVoiceMailAliasesOnLogin(Boolean allowIdentificationByPhoneNumberOrVoiceMailAliasesOnLogin)

getAllowIdentificationByPhoneNumberOrVoiceMailAliasesOnLogin

public Boolean getAllowIdentificationByPhoneNumberOrVoiceMailAliasesOnLogin()

setUseVoicePortalWizard

public GroupVoiceMessaging.GroupVoiceMessagingGroupConsolidatedModifyVoicePortalRequest setUseVoicePortalWizard(Boolean useVoicePortalWizard)

getUseVoicePortalWizard

public Boolean getUseVoicePortalWizard()

setVoicePortalExternalRoutingScope

public GroupVoiceMessaging.GroupVoiceMessagingGroupConsolidatedModifyVoicePortalRequest setVoicePortalExternalRoutingScope(VoicePortalExternalRoutingScope voicePortalExternalRoutingScope)

getVoicePortalExternalRoutingScope

public VoicePortalExternalRoutingScope getVoicePortalExternalRoutingScope()

setUseExternalRouting

public GroupVoiceMessaging.GroupVoiceMessagingGroupConsolidatedModifyVoicePortalRequest setUseExternalRouting(Boolean useExternalRouting)

getUseExternalRouting

public Boolean getUseExternalRouting()

unsetExternalRoutingAddress

public GroupVoiceMessaging.GroupVoiceMessagingGroupConsolidatedModifyVoicePortalRequest unsetExternalRoutingAddress()

setExternalRoutingAddress

public GroupVoiceMessaging.GroupVoiceMessagingGroupConsolidatedModifyVoicePortalRequest setExternalRoutingAddress(String externalRoutingAddress)

getExternalRoutingAddress

public Optional<@Size(min=1,max=161) String> getExternalRoutingAddress()

unsetHomeZoneName

public GroupVoiceMessaging.GroupVoiceMessagingGroupConsolidatedModifyVoicePortalRequest unsetHomeZoneName()

setHomeZoneName

public GroupVoiceMessaging.GroupVoiceMessagingGroupConsolidatedModifyVoicePortalRequest setHomeZoneName(String homeZoneName)

getHomeZoneName

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

setNetworkClassOfService

public GroupVoiceMessaging.GroupVoiceMessagingGroupConsolidatedModifyVoicePortalRequest setNetworkClassOfService(String networkClassOfService)

getNetworkClassOfService

public String getNetworkClassOfService()

setVoicePortalGreetingSelection

public GroupVoiceMessaging.GroupVoiceMessagingGroupConsolidatedModifyVoicePortalRequest setVoicePortalGreetingSelection(VoiceMessagingBrandingSelection voicePortalGreetingSelection)

getVoicePortalGreetingSelection

public VoiceMessagingBrandingSelection getVoicePortalGreetingSelection()

unsetVoicePortalGreetingFile

public GroupVoiceMessaging.GroupVoiceMessagingGroupConsolidatedModifyVoicePortalRequest unsetVoicePortalGreetingFile()

setVoicePortalGreetingFile

public GroupVoiceMessaging.GroupVoiceMessagingGroupConsolidatedModifyVoicePortalRequest setVoicePortalGreetingFile(AnnouncementFileKey voicePortalGreetingFile)

getVoicePortalGreetingFile

public Optional<@Valid AnnouncementFileKey> getVoicePortalGreetingFile()

setVoiceMessagingGreetingSelection

public GroupVoiceMessaging.GroupVoiceMessagingGroupConsolidatedModifyVoicePortalRequest setVoiceMessagingGreetingSelection(VoiceMessagingBrandingSelection voiceMessagingGreetingSelection)

getVoiceMessagingGreetingSelection

public VoiceMessagingBrandingSelection getVoiceMessagingGreetingSelection()

unsetVoiceMessagingGreetingFile

public GroupVoiceMessaging.GroupVoiceMessagingGroupConsolidatedModifyVoicePortalRequest unsetVoiceMessagingGreetingFile()

setVoiceMessagingGreetingFile

public GroupVoiceMessaging.GroupVoiceMessagingGroupConsolidatedModifyVoicePortalRequest setVoiceMessagingGreetingFile(AnnouncementFileKey voiceMessagingGreetingFile)

getVoiceMessagingGreetingFile

public Optional<@Valid AnnouncementFileKey> getVoiceMessagingGreetingFile()

getEmptyObject

public static GroupVoiceMessaging.GroupVoiceMessagingGroupConsolidatedModifyVoicePortalRequest 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>