Package co.ecg.alpaca.toolkit.generated

Class Group.GroupAddRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.Group.GroupAddRequest

Enclosing class:

Group

public static class Group.GroupAddRequest
extends Request<DefaultResponse>

Add a group. The response is either a SuccessResponse or an ErrorResponse. 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. Replaced by: GroupConsolidatedAddRequest in AS 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 @Valid StreetAddress	address
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 @Size(min=1,max=23) String	defaultUserCallingLineIdPhoneNumber
protected @NotNull @Size(min=1,max=30) String	groupId
protected @Size(min=1,max=80) String	groupName
protected @Size(min=1,max=15) String	locationDialingCode
protected @Size(min=1,max=80) String	preferredDataCenter
protected @Size(min=1,max=80) String	provisioningSliceId
protected @Size(min=1,max=80) String	servicePolicy
protected @NotNull @Size(min=1,max=30) String	serviceProviderId
protected @Size(min=1,max=80) String	subscriberPartition
protected @Size(min=1,max=127) String	timeZone
protected @NotNull Integer	userLimit

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

log

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
StreetAddress	getAddress()
String	getCallingLineIdName()
String	getCallProcessingSliceId()
Contact	getContact()
String	getDefaultDomain()
String	getDefaultUserCallingLineIdPhoneNumber()
static Group.GroupAddRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
String	getGroupId()
String	getGroupName()
String	getLocationDialingCode()
String	getPreferredDataCenter()
String	getProvisioningSliceId()
String	getServicePolicy()
String	getServiceProviderId()
String	getSubscriberPartition()
String	getTimeZone()
Integer	getUserLimit()
Group.GroupAddRequest	setAddress(StreetAddress address)
Group.GroupAddRequest	setCallingLineIdName(String callingLineIdName)
Group.GroupAddRequest	setCallProcessingSliceId(String callProcessingSliceId)
Group.GroupAddRequest	setContact(Contact contact)
Group.GroupAddRequest	setDefaultDomain(String defaultDomain)
Group.GroupAddRequest	setDefaultUserCallingLineIdPhoneNumber(String defaultUserCallingLineIdPhoneNumber)
Group.GroupAddRequest	setGroupId(String groupId)
Group.GroupAddRequest	setGroupName(String groupName)
Group.GroupAddRequest	setLocationDialingCode(String locationDialingCode)
Group.GroupAddRequest	setPreferredDataCenter(String preferredDataCenter)
Group.GroupAddRequest	setProvisioningSliceId(String provisioningSliceId)
Group.GroupAddRequest	setServicePolicy(String servicePolicy)
Group.GroupAddRequest	setServiceProviderId(String serviceProviderId)
Group.GroupAddRequest	setSubscriberPartition(String subscriberPartition)
Group.GroupAddRequest	setTimeZone(String timeZone)
Group.GroupAddRequest	setUserLimit(Integer userLimit)

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

serviceProviderId

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

groupId

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

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

Constructor Details

GroupAddRequest

public GroupAddRequest()

GroupAddRequest

public GroupAddRequest(BroadWorksServer broadWorksServer,
 String serviceProviderId,
 String groupId,
 String defaultDomain,
 Integer userLimit)

Method Details

setServiceProviderId

public Group.GroupAddRequest setServiceProviderId(String serviceProviderId)

getServiceProviderId

public String getServiceProviderId()

setGroupId

public Group.GroupAddRequest setGroupId(String groupId)

getGroupId

public String getGroupId()

setDefaultDomain

public Group.GroupAddRequest setDefaultDomain(String defaultDomain)

getDefaultDomain

public String getDefaultDomain()

setUserLimit

public Group.GroupAddRequest setUserLimit(Integer userLimit)

getUserLimit

public Integer getUserLimit()

setGroupName

public Group.GroupAddRequest setGroupName(String groupName)

getGroupName

public String getGroupName()

setCallingLineIdName

public Group.GroupAddRequest setCallingLineIdName(String callingLineIdName)

getCallingLineIdName

public String getCallingLineIdName()

setTimeZone

public Group.GroupAddRequest setTimeZone(String timeZone)

getTimeZone

public String getTimeZone()

setLocationDialingCode

public Group.GroupAddRequest setLocationDialingCode(String locationDialingCode)

getLocationDialingCode

public String getLocationDialingCode()

setContact

public Group.GroupAddRequest setContact(Contact contact)

getContact

public Contact getContact()

setAddress

public Group.GroupAddRequest setAddress(StreetAddress address)

getAddress

public StreetAddress getAddress()

setServicePolicy

public Group.GroupAddRequest setServicePolicy(String servicePolicy)

getServicePolicy

public String getServicePolicy()

setCallProcessingSliceId

public Group.GroupAddRequest setCallProcessingSliceId(String callProcessingSliceId)

getCallProcessingSliceId

public String getCallProcessingSliceId()

setProvisioningSliceId

public Group.GroupAddRequest setProvisioningSliceId(String provisioningSliceId)

getProvisioningSliceId

public String getProvisioningSliceId()

setSubscriberPartition

public Group.GroupAddRequest setSubscriberPartition(String subscriberPartition)

getSubscriberPartition

public String getSubscriberPartition()

setPreferredDataCenter

public Group.GroupAddRequest setPreferredDataCenter(String preferredDataCenter)

getPreferredDataCenter

public String getPreferredDataCenter()

setDefaultUserCallingLineIdPhoneNumber

public Group.GroupAddRequest setDefaultUserCallingLineIdPhoneNumber(String defaultUserCallingLineIdPhoneNumber)

getDefaultUserCallingLineIdPhoneNumber

public String getDefaultUserCallingLineIdPhoneNumber()

getEmptyObject

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