Package co.ecg.alpaca.toolkit.generated

Class AutoAttendant.GroupAutoAttendantConsolidatedAddInstanceRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.AutoAttendant.GroupAutoAttendantConsolidatedAddInstanceRequest

Enclosing class:

AutoAttendant

public static class AutoAttendant.GroupAutoAttendantConsolidatedAddInstanceRequest
extends Request<DefaultResponse>

Add a Auto Attendant instance to a group and assign services to the Auto Attendant. The domain is required in the serviceUserId. Only Group and Enterprise level schedules are accepted. The response is either SuccessResponse or ErrorResponse. If the phoneNumber has not been assigned to the group and addPhoneNumberToGroup is set to true, it will be added to group if the command is executed by a service provider administrator or above and the number is already assigned to the service provider. The command will fail otherwise. The following elements are only used in AS data mode: type, use AutoAttendantType.BASIC in XS mode. holidayMenu. The following elements are only valid for Standard Auto Attendants: holidayMenu

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 @Valid AutoAttendantAddMenu20	afterHoursMenu
protected @Valid TimeSchedule	businessHours
protected @Valid AutoAttendantAddMenu20	businessHoursMenu
protected @NotNull Boolean	enableVideo
protected @NotNull AutoAttendantDialingScope	extensionDialingScope
protected @NotNull Integer	firstDigitTimeoutSeconds
protected @NotNull @Size(min=1,max=30) String	groupId
protected @Valid AutoAttendantAddMenu20	holidayMenu
protected @Valid HolidaySchedule	holidaySchedule
protected @NotNull Boolean	isActive
protected @NotNull AutoAttendantNameDialingEntry	nameDialingEntries
protected @NotNull AutoAttendantDialingScope	nameDialingScope
protected @Size(min=1,max=40) String	networkClassOfService
protected @Valid ConsolidatedUserServiceAssignment[]	service
protected @NotNull @Valid ServiceInstanceAddProfile	serviceInstanceProfile
protected @NotNull @Size(min=1,max=30) String	serviceProviderId
protected @NotNull @Size(min=1,max=161) String	serviceUserId
protected @NotNull AutoAttendantType	type

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

log

Constructor Summary

Constructors

Constructor	Description
GroupAutoAttendantConsolidatedAddInstanceRequest()
GroupAutoAttendantConsolidatedAddInstanceRequest(BroadWorksServer broadWorksServer, String serviceProviderId, String groupId, String serviceUserId, ServiceInstanceAddProfile serviceInstanceProfile, AutoAttendantType type, Integer firstDigitTimeoutSeconds, Boolean enableVideo, AutoAttendantDialingScope extensionDialingScope, AutoAttendantDialingScope nameDialingScope, AutoAttendantNameDialingEntry nameDialingEntries, Boolean isActive)

Method Summary

Modifier and Type	Method	Description
boolean	addPhoneNumberToGroupFlagExist()
void	formRequest()	Forms the XML Document for this Request Object.
Boolean	getAddPhoneNumberToGroup()
AutoAttendantAddMenu20	getAfterHoursMenu()
TimeSchedule	getBusinessHours()
AutoAttendantAddMenu20	getBusinessHoursMenu()
static AutoAttendant.GroupAutoAttendantConsolidatedAddInstanceRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
Boolean	getEnableVideo()
AutoAttendantDialingScope	getExtensionDialingScope()
Integer	getFirstDigitTimeoutSeconds()
String	getGroupId()
AutoAttendantAddMenu20	getHolidayMenu()
HolidaySchedule	getHolidaySchedule()
Boolean	getIsActive()
AutoAttendantNameDialingEntry	getNameDialingEntries()
AutoAttendantDialingScope	getNameDialingScope()
String	getNetworkClassOfService()
ConsolidatedUserServiceAssignment[]	getService()
ServiceInstanceAddProfile	getServiceInstanceProfile()
String	getServiceProviderId()
String	getServiceUserId()
AutoAttendantType	getType()
AutoAttendant.GroupAutoAttendantConsolidatedAddInstanceRequest	setAfterHoursMenu(AutoAttendantAddMenu20 afterHoursMenu)
AutoAttendant.GroupAutoAttendantConsolidatedAddInstanceRequest	setBusinessHours(TimeSchedule businessHours)
AutoAttendant.GroupAutoAttendantConsolidatedAddInstanceRequest	setBusinessHoursMenu(AutoAttendantAddMenu20 businessHoursMenu)
AutoAttendant.GroupAutoAttendantConsolidatedAddInstanceRequest	setEnableVideo(Boolean enableVideo)
AutoAttendant.GroupAutoAttendantConsolidatedAddInstanceRequest	setExtensionDialingScope(AutoAttendantDialingScope extensionDialingScope)
AutoAttendant.GroupAutoAttendantConsolidatedAddInstanceRequest	setFirstDigitTimeoutSeconds(Integer firstDigitTimeoutSeconds)
AutoAttendant.GroupAutoAttendantConsolidatedAddInstanceRequest	setFlagAddPhoneNumberToGroup()
AutoAttendant.GroupAutoAttendantConsolidatedAddInstanceRequest	setGroupId(String groupId)
AutoAttendant.GroupAutoAttendantConsolidatedAddInstanceRequest	setHolidayMenu(AutoAttendantAddMenu20 holidayMenu)
AutoAttendant.GroupAutoAttendantConsolidatedAddInstanceRequest	setHolidaySchedule(HolidaySchedule holidaySchedule)
AutoAttendant.GroupAutoAttendantConsolidatedAddInstanceRequest	setIsActive(Boolean isActive)
AutoAttendant.GroupAutoAttendantConsolidatedAddInstanceRequest	setNameDialingEntries(AutoAttendantNameDialingEntry nameDialingEntries)
AutoAttendant.GroupAutoAttendantConsolidatedAddInstanceRequest	setNameDialingScope(AutoAttendantDialingScope nameDialingScope)
AutoAttendant.GroupAutoAttendantConsolidatedAddInstanceRequest	setNetworkClassOfService(String networkClassOfService)
AutoAttendant.GroupAutoAttendantConsolidatedAddInstanceRequest	setService(ConsolidatedUserServiceAssignment... service)
AutoAttendant.GroupAutoAttendantConsolidatedAddInstanceRequest	setServiceInstanceProfile(ServiceInstanceAddProfile serviceInstanceProfile)
AutoAttendant.GroupAutoAttendantConsolidatedAddInstanceRequest	setServiceProviderId(String serviceProviderId)
AutoAttendant.GroupAutoAttendantConsolidatedAddInstanceRequest	setServiceUserId(String serviceUserId)
AutoAttendant.GroupAutoAttendantConsolidatedAddInstanceRequest	setType(AutoAttendantType type)

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

serviceUserId

@NotNull
@Size(min=1,
      max=161)
protected @NotNull @Size(min=1,max=161) String serviceUserId

addPhoneNumberToGroup

@AssertTrue
protected @AssertTrue Boolean addPhoneNumberToGroup

serviceInstanceProfile

@NotNull
@Valid
protected @NotNull @Valid ServiceInstanceAddProfile serviceInstanceProfile

type

@NotNull
protected @NotNull AutoAttendantType type

firstDigitTimeoutSeconds

@NotNull
protected @NotNull Integer firstDigitTimeoutSeconds

enableVideo

@NotNull
protected @NotNull Boolean enableVideo

businessHours

@Valid
protected @Valid TimeSchedule businessHours

holidaySchedule

@Valid
protected @Valid HolidaySchedule holidaySchedule

extensionDialingScope

@NotNull
protected @NotNull AutoAttendantDialingScope extensionDialingScope

nameDialingScope

@NotNull
protected @NotNull AutoAttendantDialingScope nameDialingScope

nameDialingEntries

@NotNull
protected @NotNull AutoAttendantNameDialingEntry nameDialingEntries

businessHoursMenu

@Valid
protected @Valid AutoAttendantAddMenu20 businessHoursMenu

afterHoursMenu

@Valid
protected @Valid AutoAttendantAddMenu20 afterHoursMenu

holidayMenu

@Valid
protected @Valid AutoAttendantAddMenu20 holidayMenu

networkClassOfService

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

service

@Valid
protected @Valid ConsolidatedUserServiceAssignment[] service

isActive

@NotNull
protected @NotNull Boolean isActive

Constructor Details

GroupAutoAttendantConsolidatedAddInstanceRequest

public GroupAutoAttendantConsolidatedAddInstanceRequest()

GroupAutoAttendantConsolidatedAddInstanceRequest

public GroupAutoAttendantConsolidatedAddInstanceRequest(BroadWorksServer broadWorksServer,
 String serviceProviderId,
 String groupId,
 String serviceUserId,
 ServiceInstanceAddProfile serviceInstanceProfile,
 AutoAttendantType type,
 Integer firstDigitTimeoutSeconds,
 Boolean enableVideo,
 AutoAttendantDialingScope extensionDialingScope,
 AutoAttendantDialingScope nameDialingScope,
 AutoAttendantNameDialingEntry nameDialingEntries,
 Boolean isActive)

Method Details

setServiceProviderId

public AutoAttendant.GroupAutoAttendantConsolidatedAddInstanceRequest setServiceProviderId(String serviceProviderId)

getServiceProviderId

public String getServiceProviderId()

setGroupId

public AutoAttendant.GroupAutoAttendantConsolidatedAddInstanceRequest setGroupId(String groupId)

getGroupId

public String getGroupId()

setServiceUserId

public AutoAttendant.GroupAutoAttendantConsolidatedAddInstanceRequest setServiceUserId(String serviceUserId)

getServiceUserId

public String getServiceUserId()

setFlagAddPhoneNumberToGroup

public AutoAttendant.GroupAutoAttendantConsolidatedAddInstanceRequest setFlagAddPhoneNumberToGroup()

addPhoneNumberToGroupFlagExist

public boolean addPhoneNumberToGroupFlagExist()

getAddPhoneNumberToGroup

public Boolean getAddPhoneNumberToGroup()

setServiceInstanceProfile

public AutoAttendant.GroupAutoAttendantConsolidatedAddInstanceRequest setServiceInstanceProfile(ServiceInstanceAddProfile serviceInstanceProfile)

getServiceInstanceProfile

public ServiceInstanceAddProfile getServiceInstanceProfile()

setType

public AutoAttendant.GroupAutoAttendantConsolidatedAddInstanceRequest setType(AutoAttendantType type)

getType

public AutoAttendantType getType()

setFirstDigitTimeoutSeconds

public AutoAttendant.GroupAutoAttendantConsolidatedAddInstanceRequest setFirstDigitTimeoutSeconds(Integer firstDigitTimeoutSeconds)

getFirstDigitTimeoutSeconds

public Integer getFirstDigitTimeoutSeconds()

setEnableVideo

public AutoAttendant.GroupAutoAttendantConsolidatedAddInstanceRequest setEnableVideo(Boolean enableVideo)

getEnableVideo

public Boolean getEnableVideo()

setBusinessHours

public AutoAttendant.GroupAutoAttendantConsolidatedAddInstanceRequest setBusinessHours(TimeSchedule businessHours)

getBusinessHours

public TimeSchedule getBusinessHours()

setHolidaySchedule

public AutoAttendant.GroupAutoAttendantConsolidatedAddInstanceRequest setHolidaySchedule(HolidaySchedule holidaySchedule)

getHolidaySchedule

public HolidaySchedule getHolidaySchedule()

setExtensionDialingScope

public AutoAttendant.GroupAutoAttendantConsolidatedAddInstanceRequest setExtensionDialingScope(AutoAttendantDialingScope extensionDialingScope)

getExtensionDialingScope

public AutoAttendantDialingScope getExtensionDialingScope()

setNameDialingScope

public AutoAttendant.GroupAutoAttendantConsolidatedAddInstanceRequest setNameDialingScope(AutoAttendantDialingScope nameDialingScope)

getNameDialingScope

public AutoAttendantDialingScope getNameDialingScope()

setNameDialingEntries

public AutoAttendant.GroupAutoAttendantConsolidatedAddInstanceRequest setNameDialingEntries(AutoAttendantNameDialingEntry nameDialingEntries)

getNameDialingEntries

public AutoAttendantNameDialingEntry getNameDialingEntries()

setBusinessHoursMenu

public AutoAttendant.GroupAutoAttendantConsolidatedAddInstanceRequest setBusinessHoursMenu(AutoAttendantAddMenu20 businessHoursMenu)

getBusinessHoursMenu

public AutoAttendantAddMenu20 getBusinessHoursMenu()

setAfterHoursMenu

public AutoAttendant.GroupAutoAttendantConsolidatedAddInstanceRequest setAfterHoursMenu(AutoAttendantAddMenu20 afterHoursMenu)

getAfterHoursMenu

public AutoAttendantAddMenu20 getAfterHoursMenu()

setHolidayMenu

public AutoAttendant.GroupAutoAttendantConsolidatedAddInstanceRequest setHolidayMenu(AutoAttendantAddMenu20 holidayMenu)

getHolidayMenu

public AutoAttendantAddMenu20 getHolidayMenu()

setNetworkClassOfService

public AutoAttendant.GroupAutoAttendantConsolidatedAddInstanceRequest setNetworkClassOfService(String networkClassOfService)

getNetworkClassOfService

public String getNetworkClassOfService()

setService

public AutoAttendant.GroupAutoAttendantConsolidatedAddInstanceRequest setService(ConsolidatedUserServiceAssignment... service)

getService

public ConsolidatedUserServiceAssignment[] getService()

setIsActive

public AutoAttendant.GroupAutoAttendantConsolidatedAddInstanceRequest setIsActive(Boolean isActive)

getIsActive

public Boolean getIsActive()

getEmptyObject

public static AutoAttendant.GroupAutoAttendantConsolidatedAddInstanceRequest 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>