Package co.ecg.alpaca.toolkit.generated

Class Group.GroupConsolidatedAddRequest

java.lang.Object

co.ecg.alpaca.toolkit.messaging.request.Request<Group.GroupConsolidatedAddResponse>

co.ecg.alpaca.toolkit.generated.Group.GroupConsolidatedAddRequest

Enclosing class:

Group

@ChoiceGroup("serviceProviderId") @ChoiceGroup("serviceProviderExternalId")
public static class Group.GroupConsolidatedAddRequest
extends Request<Group.GroupConsolidatedAddResponse>

Add a group. The following elements are only used in AS data mode and ignored in XS data mode: serviceProviderExternalId groupExternalId 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 Group. Only Provisioning admin and above can change the callProcessingSliceId, provisioningSliceId, and subscriberPartition. The following elements are only used in Amplify and XS data mode and ignored in AS mode: preferredDataCenter. Only Provisioning admin and above can change the preferredDataCenter. The following elements are only used in XS data mode and ignored in Amplify and AS data mode: defaultUserCallingLineIdPhoneNumber. The following elements are optional for the group. If the elements are included, they will be either added, authorized, or modified on the group. Should any of the following elements be rejected to due existing system or service provider settings, the group will not be added and the response will be an ErrorResponse: domain admin minExtensionLength maxExtensionLength defaultExtensionLength servicePackAuthorization groupServiceAuthorizationAndAssignment userServiceAuthorization servicePack activatablePhoneNumber activatableDNRange routingProfile trunkGroupMaxActiveCalls trunkGroupBurstingMaxActiveCalls meetMeConferencingAllocatedPorts When a group or user service is included that is not activated, is not licensed, or not authorized to the service provider, the response will be an ErrorResponse. If activatablePhoneNumber and activatableDNRange elements are included, when activate element is present, this value overrides the system group default activatable settings. If the activatablePhoneNumber and activatableDNRange element are included, the phone numbers are added to the service provider if they are available to be assigned to the group and not currently added to the service provider. The response returned is a - SuccessResponse if all the data is successfully added. - ErrorResponse if any data other than the DN validation/assignment fails. - GroupConsolidatedAddResponse22 if any of the activatablePhoneNumber or activatableDNRange fails validation.

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 ActivatableDNRange[]	activatableDNRange
protected @Valid ActivatableDN[]	activatablePhoneNumber
protected @Valid StreetAddress	address
protected @Valid GroupAdmin[]	admin
protected @Size(min=1,max=80) String	callingLineIdName
protected @Size(min=1,max=80) String	callProcessingSliceId
protected @Valid Contact	contact
protected @NotNull @Size(min=1,max=80) String	defaultDomain
protected Integer	defaultExtensionLength
protected @Size(min=1,max=23) String	defaultUserCallingLineIdPhoneNumber
protected String[]	domain
protected @Size(max=36) String	groupExternalId
protected @Size(min=1,max=30) String	groupId
protected @Size(min=1,max=80) String	groupName
protected @Valid GroupServiceAuthorizationAndAssignment[]	groupServiceAuthorizationAndAssignment
protected @Size(min=1,max=15) String	locationDialingCode
protected Integer	maxExtensionLength
protected @Valid MeetMeConferencingConferencePorts	meetMeConferencingAllocatedPorts
protected Integer	minExtensionLength
protected @Size(min=1,max=80) String	preferredDataCenter
protected @Size(min=1,max=80) String	provisioningSliceId
protected Optional<@Size(min=4,max=12) String>	routingProfile
protected @Valid ServicePackAuthorization[]	servicePackAuthorization
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	subscriberPartition
protected @Size(min=1,max=127) String	timeZone
protected @Valid UnboundedNonNegativeInt	trunkGroupBurstingMaxActiveCalls
protected Integer	trunkGroupMaxActiveCalls
protected @NotNull Integer	userLimit
protected @Valid UserServiceAuthorization[]	userServiceAuthorization

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

log

Constructor Summary

Constructors

Constructor	Description
GroupConsolidatedAddRequest()
GroupConsolidatedAddRequest(BroadWorksServer broadWorksServer, String defaultDomain, Integer userLimit)
GroupConsolidatedAddRequest(BroadWorksServer broadWorksServer, String serviceProviderId, String defaultDomain, Integer userLimit)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
ActivatableDNRange[]	getActivatableDNRange()
ActivatableDN[]	getActivatablePhoneNumber()
StreetAddress	getAddress()
GroupAdmin[]	getAdmin()
String	getCallingLineIdName()
String	getCallProcessingSliceId()
Contact	getContact()
String	getDefaultDomain()
Integer	getDefaultExtensionLength()
String	getDefaultUserCallingLineIdPhoneNumber()
String[]	getDomain()
static Group.GroupConsolidatedAddRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
String	getGroupExternalId()
String	getGroupId()
String	getGroupName()
GroupServiceAuthorizationAndAssignment[]	getGroupServiceAuthorizationAndAssignment()
String	getLocationDialingCode()
Integer	getMaxExtensionLength()
MeetMeConferencingConferencePorts	getMeetMeConferencingAllocatedPorts()
Integer	getMinExtensionLength()
String	getPreferredDataCenter()
String	getProvisioningSliceId()
Optional<@Size(min=4,max=12) String>	getRoutingProfile()
ServicePackAuthorization[]	getServicePackAuthorization()
String	getServicePolicy()
String	getServiceProviderExternalId()
String	getServiceProviderId()
String	getSubscriberPartition()
String	getTimeZone()
UnboundedNonNegativeInt	getTrunkGroupBurstingMaxActiveCalls()
Integer	getTrunkGroupMaxActiveCalls()
Integer	getUserLimit()
UserServiceAuthorization[]	getUserServiceAuthorization()
Group.GroupConsolidatedAddRequest	setActivatableDNRange(ActivatableDNRange... activatableDNRange)
Group.GroupConsolidatedAddRequest	setActivatablePhoneNumber(ActivatableDN... activatablePhoneNumber)
Group.GroupConsolidatedAddRequest	setAddress(StreetAddress address)
Group.GroupConsolidatedAddRequest	setAdmin(GroupAdmin... admin)
Group.GroupConsolidatedAddRequest	setCallingLineIdName(String callingLineIdName)
Group.GroupConsolidatedAddRequest	setCallProcessingSliceId(String callProcessingSliceId)
Group.GroupConsolidatedAddRequest	setContact(Contact contact)
Group.GroupConsolidatedAddRequest	setDefaultDomain(String defaultDomain)
Group.GroupConsolidatedAddRequest	setDefaultExtensionLength(Integer defaultExtensionLength)
Group.GroupConsolidatedAddRequest	setDefaultUserCallingLineIdPhoneNumber(String defaultUserCallingLineIdPhoneNumber)
Group.GroupConsolidatedAddRequest	setDomain(String... domain)
Group.GroupConsolidatedAddRequest	setGroupExternalId(String groupExternalId)
Group.GroupConsolidatedAddRequest	setGroupId(String groupId)
Group.GroupConsolidatedAddRequest	setGroupName(String groupName)
Group.GroupConsolidatedAddRequest	setGroupServiceAuthorizationAndAssignment(GroupServiceAuthorizationAndAssignment... groupServiceAuthorizationAndAssignment)
Group.GroupConsolidatedAddRequest	setLocationDialingCode(String locationDialingCode)
Group.GroupConsolidatedAddRequest	setMaxExtensionLength(Integer maxExtensionLength)
Group.GroupConsolidatedAddRequest	setMeetMeConferencingAllocatedPorts(MeetMeConferencingConferencePorts meetMeConferencingAllocatedPorts)
Group.GroupConsolidatedAddRequest	setMinExtensionLength(Integer minExtensionLength)
Group.GroupConsolidatedAddRequest	setPreferredDataCenter(String preferredDataCenter)
Group.GroupConsolidatedAddRequest	setProvisioningSliceId(String provisioningSliceId)
Group.GroupConsolidatedAddRequest	setRoutingProfile(String routingProfile)
Group.GroupConsolidatedAddRequest	setServicePackAuthorization(ServicePackAuthorization... servicePackAuthorization)
Group.GroupConsolidatedAddRequest	setServicePolicy(String servicePolicy)
Group.GroupConsolidatedAddRequest	setServiceProviderExternalId(String serviceProviderExternalId)
Group.GroupConsolidatedAddRequest	setServiceProviderId(String serviceProviderId)
Group.GroupConsolidatedAddRequest	setSubscriberPartition(String subscriberPartition)
Group.GroupConsolidatedAddRequest	setTimeZone(String timeZone)
Group.GroupConsolidatedAddRequest	setTrunkGroupBurstingMaxActiveCalls(UnboundedNonNegativeInt trunkGroupBurstingMaxActiveCalls)
Group.GroupConsolidatedAddRequest	setTrunkGroupMaxActiveCalls(Integer trunkGroupMaxActiveCalls)
Group.GroupConsolidatedAddRequest	setUserLimit(Integer userLimit)
Group.GroupConsolidatedAddRequest	setUserServiceAuthorization(UserServiceAuthorization... userServiceAuthorization)
Group.GroupConsolidatedAddRequest	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 Detail

serviceProviderId

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

serviceProviderExternalId

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

groupId

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

groupExternalId

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

defaultDomain

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

userLimit

@NotNull
protected @NotNull Integer userLimit

groupName

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

callingLineIdName

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

timeZone

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

locationDialingCode

@Size(min=1,
      max=15)
protected @Size(min=1,max=15) String locationDialingCode

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

defaultUserCallingLineIdPhoneNumber

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

domain

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

admin

@Valid
protected @Valid GroupAdmin[] admin

minExtensionLength

protected Integer minExtensionLength

maxExtensionLength

protected Integer maxExtensionLength

defaultExtensionLength

protected Integer defaultExtensionLength

groupServiceAuthorizationAndAssignment

@Valid
protected @Valid GroupServiceAuthorizationAndAssignment[] groupServiceAuthorizationAndAssignment

userServiceAuthorization

@Valid
protected @Valid UserServiceAuthorization[] userServiceAuthorization

servicePackAuthorization

@Valid
protected @Valid ServicePackAuthorization[] servicePackAuthorization

activatablePhoneNumber

@Valid
protected @Valid ActivatableDN[] activatablePhoneNumber

activatableDNRange

@Valid
protected @Valid ActivatableDNRange[] activatableDNRange

routingProfile

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

meetMeConferencingAllocatedPorts

@Valid
protected @Valid MeetMeConferencingConferencePorts meetMeConferencingAllocatedPorts

trunkGroupMaxActiveCalls

protected Integer trunkGroupMaxActiveCalls

trunkGroupBurstingMaxActiveCalls

@Valid
protected @Valid UnboundedNonNegativeInt trunkGroupBurstingMaxActiveCalls

Constructor Detail

GroupConsolidatedAddRequest

public GroupConsolidatedAddRequest()

GroupConsolidatedAddRequest

public GroupConsolidatedAddRequest(BroadWorksServer broadWorksServer,
                                   String defaultDomain,
                                   Integer userLimit)

GroupConsolidatedAddRequest

public GroupConsolidatedAddRequest(BroadWorksServer broadWorksServer,
                                   String serviceProviderId,
                                   String defaultDomain,
                                   Integer userLimit)

Method Detail

setServiceProviderId

public Group.GroupConsolidatedAddRequest setServiceProviderId(String serviceProviderId)

getServiceProviderId

public String getServiceProviderId()

setServiceProviderExternalId

public Group.GroupConsolidatedAddRequest setServiceProviderExternalId(String serviceProviderExternalId)

getServiceProviderExternalId

public String getServiceProviderExternalId()

setGroupId

public Group.GroupConsolidatedAddRequest setGroupId(String groupId)

getGroupId

public String getGroupId()

setGroupExternalId

public Group.GroupConsolidatedAddRequest setGroupExternalId(String groupExternalId)

getGroupExternalId

public String getGroupExternalId()

setDefaultDomain

public Group.GroupConsolidatedAddRequest setDefaultDomain(String defaultDomain)

getDefaultDomain

public String getDefaultDomain()

setUserLimit

public Group.GroupConsolidatedAddRequest setUserLimit(Integer userLimit)

getUserLimit

public Integer getUserLimit()

setGroupName

public Group.GroupConsolidatedAddRequest setGroupName(String groupName)

getGroupName

public String getGroupName()

setCallingLineIdName

public Group.GroupConsolidatedAddRequest setCallingLineIdName(String callingLineIdName)

getCallingLineIdName

public String getCallingLineIdName()

setTimeZone

public Group.GroupConsolidatedAddRequest setTimeZone(String timeZone)

getTimeZone

public String getTimeZone()

setLocationDialingCode

public Group.GroupConsolidatedAddRequest setLocationDialingCode(String locationDialingCode)

getLocationDialingCode

public String getLocationDialingCode()

setContact

public Group.GroupConsolidatedAddRequest setContact(Contact contact)

getContact

public Contact getContact()

setAddress

public Group.GroupConsolidatedAddRequest setAddress(StreetAddress address)

getAddress

public StreetAddress getAddress()

setServicePolicy

public Group.GroupConsolidatedAddRequest setServicePolicy(String servicePolicy)

getServicePolicy

public String getServicePolicy()

setCallProcessingSliceId

public Group.GroupConsolidatedAddRequest setCallProcessingSliceId(String callProcessingSliceId)

getCallProcessingSliceId

public String getCallProcessingSliceId()

setProvisioningSliceId

public Group.GroupConsolidatedAddRequest setProvisioningSliceId(String provisioningSliceId)

getProvisioningSliceId

public String getProvisioningSliceId()

setSubscriberPartition

public Group.GroupConsolidatedAddRequest setSubscriberPartition(String subscriberPartition)

getSubscriberPartition

public String getSubscriberPartition()

setPreferredDataCenter

public Group.GroupConsolidatedAddRequest setPreferredDataCenter(String preferredDataCenter)

getPreferredDataCenter

public String getPreferredDataCenter()

setDefaultUserCallingLineIdPhoneNumber

public Group.GroupConsolidatedAddRequest setDefaultUserCallingLineIdPhoneNumber(String defaultUserCallingLineIdPhoneNumber)

getDefaultUserCallingLineIdPhoneNumber

public String getDefaultUserCallingLineIdPhoneNumber()

setDomain

public Group.GroupConsolidatedAddRequest setDomain(String... domain)

getDomain

public String[] getDomain()

setAdmin

public Group.GroupConsolidatedAddRequest setAdmin(GroupAdmin... admin)

getAdmin

public GroupAdmin[] getAdmin()

setMinExtensionLength

public Group.GroupConsolidatedAddRequest setMinExtensionLength(Integer minExtensionLength)

getMinExtensionLength

public Integer getMinExtensionLength()

setMaxExtensionLength

public Group.GroupConsolidatedAddRequest setMaxExtensionLength(Integer maxExtensionLength)

getMaxExtensionLength

public Integer getMaxExtensionLength()

setDefaultExtensionLength

public Group.GroupConsolidatedAddRequest setDefaultExtensionLength(Integer defaultExtensionLength)

getDefaultExtensionLength

public Integer getDefaultExtensionLength()

setGroupServiceAuthorizationAndAssignment

public Group.GroupConsolidatedAddRequest setGroupServiceAuthorizationAndAssignment(GroupServiceAuthorizationAndAssignment... groupServiceAuthorizationAndAssignment)

getGroupServiceAuthorizationAndAssignment

public GroupServiceAuthorizationAndAssignment[] getGroupServiceAuthorizationAndAssignment()

setUserServiceAuthorization

public Group.GroupConsolidatedAddRequest setUserServiceAuthorization(UserServiceAuthorization... userServiceAuthorization)

getUserServiceAuthorization

public UserServiceAuthorization[] getUserServiceAuthorization()

setServicePackAuthorization

public Group.GroupConsolidatedAddRequest setServicePackAuthorization(ServicePackAuthorization... servicePackAuthorization)

getServicePackAuthorization

public ServicePackAuthorization[] getServicePackAuthorization()

setActivatablePhoneNumber

public Group.GroupConsolidatedAddRequest setActivatablePhoneNumber(ActivatableDN... activatablePhoneNumber)

getActivatablePhoneNumber

public ActivatableDN[] getActivatablePhoneNumber()

setActivatableDNRange

public Group.GroupConsolidatedAddRequest setActivatableDNRange(ActivatableDNRange... activatableDNRange)

getActivatableDNRange

public ActivatableDNRange[] getActivatableDNRange()

unsetRoutingProfile

public Group.GroupConsolidatedAddRequest unsetRoutingProfile()

setRoutingProfile

public Group.GroupConsolidatedAddRequest setRoutingProfile(String routingProfile)

getRoutingProfile

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

setMeetMeConferencingAllocatedPorts

public Group.GroupConsolidatedAddRequest setMeetMeConferencingAllocatedPorts(MeetMeConferencingConferencePorts meetMeConferencingAllocatedPorts)

getMeetMeConferencingAllocatedPorts

public MeetMeConferencingConferencePorts getMeetMeConferencingAllocatedPorts()

setTrunkGroupMaxActiveCalls

public Group.GroupConsolidatedAddRequest setTrunkGroupMaxActiveCalls(Integer trunkGroupMaxActiveCalls)

getTrunkGroupMaxActiveCalls

public Integer getTrunkGroupMaxActiveCalls()

setTrunkGroupBurstingMaxActiveCalls

public Group.GroupConsolidatedAddRequest setTrunkGroupBurstingMaxActiveCalls(UnboundedNonNegativeInt trunkGroupBurstingMaxActiveCalls)

getTrunkGroupBurstingMaxActiveCalls

public UnboundedNonNegativeInt getTrunkGroupBurstingMaxActiveCalls()

getEmptyObject

public static Group.GroupConsolidatedAddRequest 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<Group.GroupConsolidatedAddResponse>