Package co.ecg.alpaca.toolkit.generated

Class Group.GroupModifyRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.Group.GroupModifyRequest

Enclosing class:

Group

public static class Group.GroupModifyRequest
extends Request<DefaultResponse>

Modify the profile for 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 set to nillable, it will be assigned to the default Slice. 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 data 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 only used in AS data mode and ignored in the XS data mode: extensionLengthSettings dialPlanAccessCode dialPlanPolicy

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 Optional<@Size(min=1,max=80) String>	callingLineIdName
protected Optional<@Size(min=1,max=23) String>	callingLineIdPhoneNumber
protected Optional<@Size(min=1,max=80) String>	callProcessingSliceId
protected @Valid Contact	contact
protected @Size(min=1,max=80) String	defaultDomain
protected Optional<@Size(min=1,max=23) String>	defaultUserCallingLineIdPhoneNumber
protected Optional<@Valid DialPlanPolicyAccessCode>	dialPlanAccessCode
protected @Valid DialPlanPolicy	dialPlanPolicy
protected @Valid GroupExtensionLengthSettings	extensionLengthSettings
protected @NotNull @Valid Group	group
protected Optional<@Size(min=1,max=80) String>	groupName
protected Optional<@Size(min=1,max=15) String>	locationDialingCode
protected Optional<@Size(min=1,max=80) String>	preferredDataCenter
protected Optional<@Size(min=1,max=80) String>	provisioningSliceId
protected Optional<@Size(min=1,max=80) String>	servicePolicy
protected Optional<@Size(min=1,max=80) String>	subscriberPartition
protected @Size(min=1,max=127) String	timeZone
protected Integer	userLimit

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

log

Constructor Summary

Constructors

Constructor	Description
GroupModifyRequest()
GroupModifyRequest(Group group)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
StreetAddress	getAddress()
Optional<@Size(min=1,max=80) String>	getCallingLineIdName()
Optional<@Size(min=1,max=23) String>	getCallingLineIdPhoneNumber()
Optional<@Size(min=1,max=80) String>	getCallProcessingSliceId()
Contact	getContact()
String	getDefaultDomain()
Optional<@Size(min=1,max=23) String>	getDefaultUserCallingLineIdPhoneNumber()
Optional<@Valid DialPlanPolicyAccessCode>	getDialPlanAccessCode()
DialPlanPolicy	getDialPlanPolicy()
static Group.GroupModifyRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
GroupExtensionLengthSettings	getExtensionLengthSettings()
Group	getGroup()
Optional<@Size(min=1,max=80) String>	getGroupName()
Optional<@Size(min=1,max=15) String>	getLocationDialingCode()
Optional<@Size(min=1,max=80) String>	getPreferredDataCenter()
Optional<@Size(min=1,max=80) String>	getProvisioningSliceId()
Optional<@Size(min=1,max=80) String>	getServicePolicy()
Optional<@Size(min=1,max=80) String>	getSubscriberPartition()
String	getTimeZone()
Integer	getUserLimit()
Group.GroupModifyRequest	setAddress(StreetAddress address)
Group.GroupModifyRequest	setCallingLineIdName(String callingLineIdName)
Group.GroupModifyRequest	setCallingLineIdPhoneNumber(String callingLineIdPhoneNumber)
Group.GroupModifyRequest	setCallProcessingSliceId(String callProcessingSliceId)
Group.GroupModifyRequest	setContact(Contact contact)
Group.GroupModifyRequest	setDefaultDomain(String defaultDomain)
Group.GroupModifyRequest	setDefaultUserCallingLineIdPhoneNumber(String defaultUserCallingLineIdPhoneNumber)
Group.GroupModifyRequest	setDialPlanAccessCode(DialPlanPolicyAccessCode dialPlanAccessCode)
Group.GroupModifyRequest	setDialPlanPolicy(DialPlanPolicy dialPlanPolicy)
Group.GroupModifyRequest	setExtensionLengthSettings(GroupExtensionLengthSettings extensionLengthSettings)
Group.GroupModifyRequest	setGroup(Group group)
Group.GroupModifyRequest	setGroupName(String groupName)
Group.GroupModifyRequest	setLocationDialingCode(String locationDialingCode)
Group.GroupModifyRequest	setPreferredDataCenter(String preferredDataCenter)
Group.GroupModifyRequest	setProvisioningSliceId(String provisioningSliceId)
Group.GroupModifyRequest	setServicePolicy(String servicePolicy)
Group.GroupModifyRequest	setSubscriberPartition(String subscriberPartition)
Group.GroupModifyRequest	setTimeZone(String timeZone)
Group.GroupModifyRequest	setUserLimit(Integer userLimit)
Group.GroupModifyRequest	unsetCallingLineIdName()
Group.GroupModifyRequest	unsetCallingLineIdPhoneNumber()
Group.GroupModifyRequest	unsetCallProcessingSliceId()
Group.GroupModifyRequest	unsetDefaultUserCallingLineIdPhoneNumber()
Group.GroupModifyRequest	unsetDialPlanAccessCode()
Group.GroupModifyRequest	unsetGroupName()
Group.GroupModifyRequest	unsetLocationDialingCode()
Group.GroupModifyRequest	unsetPreferredDataCenter()
Group.GroupModifyRequest	unsetProvisioningSliceId()
Group.GroupModifyRequest	unsetServicePolicy()
Group.GroupModifyRequest	unsetSubscriberPartition()

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

group

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

defaultDomain

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

userLimit

protected Integer userLimit

groupName

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

callingLineIdName

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

callingLineIdPhoneNumber

protected Optional<@Size(min=1,max=23) String> callingLineIdPhoneNumber

timeZone

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

locationDialingCode

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

contact

@Valid
protected @Valid Contact contact

address

@Valid
protected @Valid StreetAddress address

servicePolicy

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

callProcessingSliceId

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

provisioningSliceId

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

subscriberPartition

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

preferredDataCenter

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

defaultUserCallingLineIdPhoneNumber

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

extensionLengthSettings

@Valid
protected @Valid GroupExtensionLengthSettings extensionLengthSettings

dialPlanAccessCode

protected Optional<@Valid DialPlanPolicyAccessCode> dialPlanAccessCode

dialPlanPolicy

@Valid
protected @Valid DialPlanPolicy dialPlanPolicy

Constructor Details

GroupModifyRequest

public GroupModifyRequest()

GroupModifyRequest

public GroupModifyRequest(Group group)

Method Details

setGroup

public Group.GroupModifyRequest setGroup(Group group)

getGroup

public Group getGroup()

setDefaultDomain

public Group.GroupModifyRequest setDefaultDomain(String defaultDomain)

getDefaultDomain

public String getDefaultDomain()

setUserLimit

public Group.GroupModifyRequest setUserLimit(Integer userLimit)

getUserLimit

public Integer getUserLimit()

unsetGroupName

public Group.GroupModifyRequest unsetGroupName()

setGroupName

public Group.GroupModifyRequest setGroupName(String groupName)

getGroupName

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

unsetCallingLineIdName

public Group.GroupModifyRequest unsetCallingLineIdName()

setCallingLineIdName

public Group.GroupModifyRequest setCallingLineIdName(String callingLineIdName)

getCallingLineIdName

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

unsetCallingLineIdPhoneNumber

public Group.GroupModifyRequest unsetCallingLineIdPhoneNumber()

setCallingLineIdPhoneNumber

public Group.GroupModifyRequest setCallingLineIdPhoneNumber(String callingLineIdPhoneNumber)

getCallingLineIdPhoneNumber

public Optional<@Size(min=1,max=23) String> getCallingLineIdPhoneNumber()

setTimeZone

public Group.GroupModifyRequest setTimeZone(String timeZone)

getTimeZone

public String getTimeZone()

unsetLocationDialingCode

public Group.GroupModifyRequest unsetLocationDialingCode()

setLocationDialingCode

public Group.GroupModifyRequest setLocationDialingCode(String locationDialingCode)

getLocationDialingCode

public Optional<@Size(min=1,max=15) String> getLocationDialingCode()

setContact

public Group.GroupModifyRequest setContact(Contact contact)

getContact

public Contact getContact()

setAddress

public Group.GroupModifyRequest setAddress(StreetAddress address)

getAddress

public StreetAddress getAddress()

unsetServicePolicy

public Group.GroupModifyRequest unsetServicePolicy()

setServicePolicy

public Group.GroupModifyRequest setServicePolicy(String servicePolicy)

getServicePolicy

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

unsetCallProcessingSliceId

public Group.GroupModifyRequest unsetCallProcessingSliceId()

setCallProcessingSliceId

public Group.GroupModifyRequest setCallProcessingSliceId(String callProcessingSliceId)

getCallProcessingSliceId

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

unsetProvisioningSliceId

public Group.GroupModifyRequest unsetProvisioningSliceId()

setProvisioningSliceId

public Group.GroupModifyRequest setProvisioningSliceId(String provisioningSliceId)

getProvisioningSliceId

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

unsetSubscriberPartition

public Group.GroupModifyRequest unsetSubscriberPartition()

setSubscriberPartition

public Group.GroupModifyRequest setSubscriberPartition(String subscriberPartition)

getSubscriberPartition

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

unsetPreferredDataCenter

public Group.GroupModifyRequest unsetPreferredDataCenter()

setPreferredDataCenter

public Group.GroupModifyRequest setPreferredDataCenter(String preferredDataCenter)

getPreferredDataCenter

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

unsetDefaultUserCallingLineIdPhoneNumber

public Group.GroupModifyRequest unsetDefaultUserCallingLineIdPhoneNumber()

setDefaultUserCallingLineIdPhoneNumber

public Group.GroupModifyRequest setDefaultUserCallingLineIdPhoneNumber(String defaultUserCallingLineIdPhoneNumber)

getDefaultUserCallingLineIdPhoneNumber

public Optional<@Size(min=1,max=23) String> getDefaultUserCallingLineIdPhoneNumber()

setExtensionLengthSettings

public Group.GroupModifyRequest setExtensionLengthSettings(GroupExtensionLengthSettings extensionLengthSettings)

getExtensionLengthSettings

public GroupExtensionLengthSettings getExtensionLengthSettings()

unsetDialPlanAccessCode

public Group.GroupModifyRequest unsetDialPlanAccessCode()

setDialPlanAccessCode

public Group.GroupModifyRequest setDialPlanAccessCode(DialPlanPolicyAccessCode dialPlanAccessCode)

getDialPlanAccessCode

public Optional<@Valid DialPlanPolicyAccessCode> getDialPlanAccessCode()

setDialPlanPolicy

public Group.GroupModifyRequest setDialPlanPolicy(DialPlanPolicy dialPlanPolicy)

getDialPlanPolicy

public DialPlanPolicy getDialPlanPolicy()

getEmptyObject

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