Package co.ecg.alpaca.toolkit.generated

Class ServiceProvider.ServiceProviderConsolidatedAddRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.ServiceProvider.ServiceProviderConsolidatedAddRequest

Enclosing class:

ServiceProvider

@ChoiceGroup("isEnterprise") @ChoiceGroup("useCustomRoutingProfile")
public static class ServiceProvider.ServiceProviderConsolidatedAddRequest
extends Request<DefaultResponse>

Add a service provider or enterprise. The response is either a SuccessResponse or an ErrorResponse. The following elements are only used in AS data mode and ignored in XS data mode: serviceProviderExtenalId The following elements are only used in Amplify data mode and ignored in AS and XS data mode: servicePolicy, callProcessingSliceId, provisioningSliceId, subscriberPartition. When the callProcessingSliceId or provisioningSliceId is not specified in the AmplifyDataMode, the default slice Id is assigned to the service provider. Only Provisioning admin and above can change the callProcessingSliceId, provisioningSliceId, andsubscriberPartition. The following elements are only used in Amplify and XS data mode and ignored in AS data mode: preferredDataCenter. Only Provisioning admin and above can change the preferredDataCenter. The following data elements are only used in AS data mode: resellerId resellerName The following behavior is only applicable in CloudPBX: - when new resellerId, that does not exist in the system, is specified, the new Reseller is created the given resellerId and resellerName (if provided) and enterprise/Service Provider is moved to the newly created Reseller. resellerName element is ignored if the reseller the service provider is being moved to already exists. The following elements are optional for the service provider. If the elements are included, they will be either added, authorized, or modified on the service provider. Should any of the following elements be rejected to due existing system settings, the service provider will not be added and the response will be an ErrorResponse: domain admin groupServiceAuthorization userServiceAuthorization servicePack phoneNumber dnRange routingProfile meetMeConferencingAllocatedPorts trunkGroupMaxActiveCalls trunkGroupBurstingMaxActiveCalls voiceMessagingGroupSettings voiceMessagingVoicePortalScope When a group or user service is included that is not activated or is not licensed, the response will be an 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 @Valid StreetAddress	address
protected @Valid ServiceProviderAdmin[]	admin
protected @Size(min=1,max=80) String	callProcessingSliceId
protected @Valid Contact	contact
protected @NotNull @Size(min=1,max=80) String	defaultDomain
protected @Valid DNRange[]	dnRange
protected String[]	domain
protected @Valid GroupServiceAuthorization[]	groupServiceAuthorization
protected @AssertTrue Boolean	isEnterprise
protected @Valid MeetMeConferencingConferencePorts	meetMeConferencingAllocatedPorts
protected String[]	phoneNumber
protected @Size(min=1,max=80) String	preferredDataCenter
protected @Size(min=1,max=80) String	provisioningSliceId
protected @Size(min=1,max=36) String	resellerId
protected @Size(min=1,max=320) String	resellerName
protected Optional<@Size(min=4,max=12) String>	routingProfile
protected @Valid ServicePack[]	servicePack
protected @Size(min=1,max=80) String	servicePolicy
protected @Size(max=36) String	serviceProviderExternalId
protected @Size(min=1,max=30) String	serviceProviderId
protected @Size(min=1,max=80) String	serviceProviderName
protected @Size(min=1,max=80) String	subscriberPartition
protected @Size(min=1,max=80) String	supportEmail
protected @Valid UnboundedNonNegativeInt	trunkGroupBurstingMaxActiveCalls
protected @Valid UnboundedNonNegativeInt	trunkGroupMaxActiveCalls
protected Boolean	useCustomRoutingProfile
protected @Valid UserServiceAuthorization[]	userServiceAuthorization
protected @Valid ServiceProviderVoiceMessagingGroupSettingsAdd	voiceMessagingGroupSettings
protected ServiceProviderVoicePortalScope	voiceMessagingGroupVoicePortalScope

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

log

Constructor Summary

Constructors

Constructor	Description
ServiceProviderConsolidatedAddRequest()
ServiceProviderConsolidatedAddRequest(BroadWorksServer broadWorksServer, Boolean isEnterprise, String defaultDomain)
ServiceProviderConsolidatedAddRequest(BroadWorksServer broadWorksServer, String defaultDomain)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
StreetAddress	getAddress()
ServiceProviderAdmin[]	getAdmin()
String	getCallProcessingSliceId()
Contact	getContact()
String	getDefaultDomain()
DNRange[]	getDnRange()
String[]	getDomain()
static ServiceProvider.ServiceProviderConsolidatedAddRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
GroupServiceAuthorization[]	getGroupServiceAuthorization()
Boolean	getIsEnterprise()
MeetMeConferencingConferencePorts	getMeetMeConferencingAllocatedPorts()
String[]	getPhoneNumber()
String	getPreferredDataCenter()
String	getProvisioningSliceId()
String	getResellerId()
String	getResellerName()
Optional<@Size(min=4,max=12) String>	getRoutingProfile()
ServicePack[]	getServicePack()
String	getServicePolicy()
String	getServiceProviderExternalId()
String	getServiceProviderId()
String	getServiceProviderName()
String	getSubscriberPartition()
String	getSupportEmail()
UnboundedNonNegativeInt	getTrunkGroupBurstingMaxActiveCalls()
UnboundedNonNegativeInt	getTrunkGroupMaxActiveCalls()
Boolean	getUseCustomRoutingProfile()
UserServiceAuthorization[]	getUserServiceAuthorization()
ServiceProviderVoiceMessagingGroupSettingsAdd	getVoiceMessagingGroupSettings()
ServiceProviderVoicePortalScope	getVoiceMessagingGroupVoicePortalScope()
boolean	isEnterpriseFlagExist()
ServiceProvider.ServiceProviderConsolidatedAddRequest	setAddress(StreetAddress address)
ServiceProvider.ServiceProviderConsolidatedAddRequest	setAdmin(ServiceProviderAdmin... admin)
ServiceProvider.ServiceProviderConsolidatedAddRequest	setCallProcessingSliceId(String callProcessingSliceId)
ServiceProvider.ServiceProviderConsolidatedAddRequest	setContact(Contact contact)
ServiceProvider.ServiceProviderConsolidatedAddRequest	setDefaultDomain(String defaultDomain)
ServiceProvider.ServiceProviderConsolidatedAddRequest	setDnRange(DNRange... dnRange)
ServiceProvider.ServiceProviderConsolidatedAddRequest	setDomain(String... domain)
ServiceProvider.ServiceProviderConsolidatedAddRequest	setFlagIsEnterprise()
ServiceProvider.ServiceProviderConsolidatedAddRequest	setGroupServiceAuthorization(GroupServiceAuthorization... groupServiceAuthorization)
ServiceProvider.ServiceProviderConsolidatedAddRequest	setMeetMeConferencingAllocatedPorts(MeetMeConferencingConferencePorts meetMeConferencingAllocatedPorts)
ServiceProvider.ServiceProviderConsolidatedAddRequest	setPhoneNumber(String... phoneNumber)
ServiceProvider.ServiceProviderConsolidatedAddRequest	setPreferredDataCenter(String preferredDataCenter)
ServiceProvider.ServiceProviderConsolidatedAddRequest	setProvisioningSliceId(String provisioningSliceId)
ServiceProvider.ServiceProviderConsolidatedAddRequest	setResellerId(String resellerId)
ServiceProvider.ServiceProviderConsolidatedAddRequest	setResellerName(String resellerName)
ServiceProvider.ServiceProviderConsolidatedAddRequest	setRoutingProfile(String routingProfile)
ServiceProvider.ServiceProviderConsolidatedAddRequest	setServicePack(ServicePack... servicePack)
ServiceProvider.ServiceProviderConsolidatedAddRequest	setServicePolicy(String servicePolicy)
ServiceProvider.ServiceProviderConsolidatedAddRequest	setServiceProviderExternalId(String serviceProviderExternalId)
ServiceProvider.ServiceProviderConsolidatedAddRequest	setServiceProviderId(String serviceProviderId)
ServiceProvider.ServiceProviderConsolidatedAddRequest	setServiceProviderName(String serviceProviderName)
ServiceProvider.ServiceProviderConsolidatedAddRequest	setSubscriberPartition(String subscriberPartition)
ServiceProvider.ServiceProviderConsolidatedAddRequest	setSupportEmail(String supportEmail)
ServiceProvider.ServiceProviderConsolidatedAddRequest	setTrunkGroupBurstingMaxActiveCalls(UnboundedNonNegativeInt trunkGroupBurstingMaxActiveCalls)
ServiceProvider.ServiceProviderConsolidatedAddRequest	setTrunkGroupMaxActiveCalls(UnboundedNonNegativeInt trunkGroupMaxActiveCalls)
ServiceProvider.ServiceProviderConsolidatedAddRequest	setUseCustomRoutingProfile(Boolean useCustomRoutingProfile)
ServiceProvider.ServiceProviderConsolidatedAddRequest	setUserServiceAuthorization(UserServiceAuthorization... userServiceAuthorization)
ServiceProvider.ServiceProviderConsolidatedAddRequest	setVoiceMessagingGroupSettings(ServiceProviderVoiceMessagingGroupSettingsAdd voiceMessagingGroupSettings)
ServiceProvider.ServiceProviderConsolidatedAddRequest	setVoiceMessagingGroupVoicePortalScope(ServiceProviderVoicePortalScope voiceMessagingGroupVoicePortalScope)
ServiceProvider.ServiceProviderConsolidatedAddRequest	unsetRoutingProfile()

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

isEnterprise

@AssertTrue
protected @AssertTrue Boolean isEnterprise

useCustomRoutingProfile

protected Boolean useCustomRoutingProfile

serviceProviderId

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

serviceProviderExternalId

@Size(max=36)
protected @Size(max=36) String serviceProviderExternalId

defaultDomain

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

serviceProviderName

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

supportEmail

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

contact

@Valid
protected @Valid Contact contact

address

@Valid
protected @Valid StreetAddress address

servicePolicy

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

callProcessingSliceId

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

provisioningSliceId

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

subscriberPartition

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

preferredDataCenter

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

resellerId

@Size(min=1,
      max=36)
protected @Size(min=1,max=36) String resellerId

resellerName

@Size(min=1,
      max=320)
protected @Size(min=1,max=320) String resellerName

domain

@StringArrayElementSize(min=1,
                        max=80)
protected String[] domain

admin

@Valid
protected @Valid ServiceProviderAdmin[] admin

groupServiceAuthorization

@Valid
protected @Valid GroupServiceAuthorization[] groupServiceAuthorization

userServiceAuthorization

@Valid
protected @Valid UserServiceAuthorization[] userServiceAuthorization

servicePack

@Valid
protected @Valid ServicePack[] servicePack

phoneNumber

@StringArrayElementSize(min=1,
                        max=23)
protected String[] phoneNumber

dnRange

@Valid
protected @Valid DNRange[] dnRange

routingProfile

protected Optional<@Size(min=4,max=12) String> routingProfile

meetMeConferencingAllocatedPorts

@Valid
protected @Valid MeetMeConferencingConferencePorts meetMeConferencingAllocatedPorts

trunkGroupMaxActiveCalls

@Valid
protected @Valid UnboundedNonNegativeInt trunkGroupMaxActiveCalls

trunkGroupBurstingMaxActiveCalls

@Valid
protected @Valid UnboundedNonNegativeInt trunkGroupBurstingMaxActiveCalls

voiceMessagingGroupSettings

@Valid
protected @Valid ServiceProviderVoiceMessagingGroupSettingsAdd voiceMessagingGroupSettings

voiceMessagingGroupVoicePortalScope

protected ServiceProviderVoicePortalScope voiceMessagingGroupVoicePortalScope

Constructor Details

ServiceProviderConsolidatedAddRequest

public ServiceProviderConsolidatedAddRequest()

ServiceProviderConsolidatedAddRequest

public ServiceProviderConsolidatedAddRequest(BroadWorksServer broadWorksServer,
 String defaultDomain)

ServiceProviderConsolidatedAddRequest

public ServiceProviderConsolidatedAddRequest(BroadWorksServer broadWorksServer,
 Boolean isEnterprise,
 String defaultDomain)

Method Details

setFlagIsEnterprise

public ServiceProvider.ServiceProviderConsolidatedAddRequest setFlagIsEnterprise()

isEnterpriseFlagExist

public boolean isEnterpriseFlagExist()

getIsEnterprise

public Boolean getIsEnterprise()

setUseCustomRoutingProfile

public ServiceProvider.ServiceProviderConsolidatedAddRequest setUseCustomRoutingProfile(Boolean useCustomRoutingProfile)

getUseCustomRoutingProfile

public Boolean getUseCustomRoutingProfile()

setServiceProviderId

public ServiceProvider.ServiceProviderConsolidatedAddRequest setServiceProviderId(String serviceProviderId)

getServiceProviderId

public String getServiceProviderId()

setServiceProviderExternalId

public ServiceProvider.ServiceProviderConsolidatedAddRequest setServiceProviderExternalId(String serviceProviderExternalId)

getServiceProviderExternalId

public String getServiceProviderExternalId()

setDefaultDomain

public ServiceProvider.ServiceProviderConsolidatedAddRequest setDefaultDomain(String defaultDomain)

getDefaultDomain

public String getDefaultDomain()

setServiceProviderName

public ServiceProvider.ServiceProviderConsolidatedAddRequest setServiceProviderName(String serviceProviderName)

getServiceProviderName

public String getServiceProviderName()

setSupportEmail

public ServiceProvider.ServiceProviderConsolidatedAddRequest setSupportEmail(String supportEmail)

getSupportEmail

public String getSupportEmail()

setContact

public ServiceProvider.ServiceProviderConsolidatedAddRequest setContact(Contact contact)

getContact

public Contact getContact()

setAddress

public ServiceProvider.ServiceProviderConsolidatedAddRequest setAddress(StreetAddress address)

getAddress

public StreetAddress getAddress()

setServicePolicy

public ServiceProvider.ServiceProviderConsolidatedAddRequest setServicePolicy(String servicePolicy)

getServicePolicy

public String getServicePolicy()

setCallProcessingSliceId

public ServiceProvider.ServiceProviderConsolidatedAddRequest setCallProcessingSliceId(String callProcessingSliceId)

getCallProcessingSliceId

public String getCallProcessingSliceId()

setProvisioningSliceId

public ServiceProvider.ServiceProviderConsolidatedAddRequest setProvisioningSliceId(String provisioningSliceId)

getProvisioningSliceId

public String getProvisioningSliceId()

setSubscriberPartition

public ServiceProvider.ServiceProviderConsolidatedAddRequest setSubscriberPartition(String subscriberPartition)

getSubscriberPartition

public String getSubscriberPartition()

setPreferredDataCenter

public ServiceProvider.ServiceProviderConsolidatedAddRequest setPreferredDataCenter(String preferredDataCenter)

getPreferredDataCenter

public String getPreferredDataCenter()

setResellerId

public ServiceProvider.ServiceProviderConsolidatedAddRequest setResellerId(String resellerId)

getResellerId

public String getResellerId()

setResellerName

public ServiceProvider.ServiceProviderConsolidatedAddRequest setResellerName(String resellerName)

getResellerName

public String getResellerName()

setDomain

public ServiceProvider.ServiceProviderConsolidatedAddRequest setDomain(String... domain)

getDomain

public String[] getDomain()

setAdmin

public ServiceProvider.ServiceProviderConsolidatedAddRequest setAdmin(ServiceProviderAdmin... admin)

getAdmin

public ServiceProviderAdmin[] getAdmin()

setGroupServiceAuthorization

public ServiceProvider.ServiceProviderConsolidatedAddRequest setGroupServiceAuthorization(GroupServiceAuthorization... groupServiceAuthorization)

getGroupServiceAuthorization

public GroupServiceAuthorization[] getGroupServiceAuthorization()

setUserServiceAuthorization

public ServiceProvider.ServiceProviderConsolidatedAddRequest setUserServiceAuthorization(UserServiceAuthorization... userServiceAuthorization)

getUserServiceAuthorization

public UserServiceAuthorization[] getUserServiceAuthorization()

setServicePack

public ServiceProvider.ServiceProviderConsolidatedAddRequest setServicePack(ServicePack... servicePack)

getServicePack

public ServicePack[] getServicePack()

setPhoneNumber

public ServiceProvider.ServiceProviderConsolidatedAddRequest setPhoneNumber(String... phoneNumber)

getPhoneNumber

public String[] getPhoneNumber()

setDnRange

public ServiceProvider.ServiceProviderConsolidatedAddRequest setDnRange(DNRange... dnRange)

getDnRange

public DNRange[] getDnRange()

unsetRoutingProfile

public ServiceProvider.ServiceProviderConsolidatedAddRequest unsetRoutingProfile()

setRoutingProfile

public ServiceProvider.ServiceProviderConsolidatedAddRequest setRoutingProfile(String routingProfile)

getRoutingProfile

public Optional<@Size(min=4,max=12) String> getRoutingProfile()

setMeetMeConferencingAllocatedPorts

public ServiceProvider.ServiceProviderConsolidatedAddRequest setMeetMeConferencingAllocatedPorts(MeetMeConferencingConferencePorts meetMeConferencingAllocatedPorts)

getMeetMeConferencingAllocatedPorts

public MeetMeConferencingConferencePorts getMeetMeConferencingAllocatedPorts()

setTrunkGroupMaxActiveCalls

public ServiceProvider.ServiceProviderConsolidatedAddRequest setTrunkGroupMaxActiveCalls(UnboundedNonNegativeInt trunkGroupMaxActiveCalls)

getTrunkGroupMaxActiveCalls

public UnboundedNonNegativeInt getTrunkGroupMaxActiveCalls()

setTrunkGroupBurstingMaxActiveCalls

public ServiceProvider.ServiceProviderConsolidatedAddRequest setTrunkGroupBurstingMaxActiveCalls(UnboundedNonNegativeInt trunkGroupBurstingMaxActiveCalls)

getTrunkGroupBurstingMaxActiveCalls

public UnboundedNonNegativeInt getTrunkGroupBurstingMaxActiveCalls()

setVoiceMessagingGroupSettings

public ServiceProvider.ServiceProviderConsolidatedAddRequest setVoiceMessagingGroupSettings(ServiceProviderVoiceMessagingGroupSettingsAdd voiceMessagingGroupSettings)

getVoiceMessagingGroupSettings

public ServiceProviderVoiceMessagingGroupSettingsAdd getVoiceMessagingGroupSettings()

setVoiceMessagingGroupVoicePortalScope

public ServiceProvider.ServiceProviderConsolidatedAddRequest setVoiceMessagingGroupVoicePortalScope(ServiceProviderVoicePortalScope voiceMessagingGroupVoicePortalScope)

getVoiceMessagingGroupVoicePortalScope

public ServiceProviderVoicePortalScope getVoiceMessagingGroupVoicePortalScope()

getEmptyObject

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