Package co.ecg.alpaca.toolkit.generated
Class AutoAttendant.GroupAutoAttendantConsolidatedModifyInstanceRequest
java.lang.Object
co.ecg.alpaca.toolkit.messaging.request.Request<DefaultResponse>
co.ecg.alpaca.toolkit.generated.AutoAttendant.GroupAutoAttendantConsolidatedModifyInstanceRequest
- Enclosing class:
- AutoAttendant
public static class AutoAttendant.GroupAutoAttendantConsolidatedModifyInstanceRequest
extends Request<DefaultResponse>
Request to modify an Auto Attendant instance and assign services to the Auto Attendant. Only Group and Enterprise level schedules are accepted. The response is either SuccessResponse or ErrorResponse. When phone numbers are un-assigned from the user, the unused numbers may be un-assigned from the group and service provider. If UnassignPhoneNumbersLevel is set to 'Group', the user's primary phone number, fax number and any alternate numbers, will be un-assigned from the group if the command is executed by a service provider administrator or above. When set to 'Service Provider', they will be un-assigned from the group and service provider if the command is executed by a provisioning administrator or above. When omitted, the number(s) will be left assigned to the group. An ErrorResponse will be returned if any number cannot be unassigned because of insufficient privilege. If the phoneNumber has not been assigned to the group and addPhoneNumberToGroup is set to true, it will be added to group if needed if the command is executed by a service provider administrator and above. The command will fail otherwise. The following elements are only used in AS data 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
FieldsModifier and TypeFieldDescriptionprotected @AssertTrue Booleanprotected @Valid AutoAttendantModifyMenu20protected Optional<@Valid TimeSchedule>protected @Valid AutoAttendantModifyMenu20protected Booleanprotected AutoAttendantDialingScopeprotected Integerprotected @Valid AutoAttendantModifyMenu20protected Optional<@Valid HolidaySchedule>protected Booleanprotected AutoAttendantNameDialingEntryprotected AutoAttendantDialingScopeprotected @Size(min=1,max=40) Stringprotected @Valid ServiceInstanceModifyProfileprotected Optional<@Valid ReplacementConsolidatedUserServiceAssignmentList>protected AnnouncementSelectionprotected Optional<@Valid AnnouncementFileLevelKey>protected Optional<@Valid AnnouncementFileLevelKey>protected UnassignPhoneNumbersLevelprotected @NotNull @Valid AutoAttendant -
Constructor Summary
ConstructorsConstructorDescription -
Method Summary
Modifier and TypeMethodDescriptionbooleanvoidForms the XML Document for this Request Object.Optional<@Valid TimeSchedule>getEmptyObject(BroadWorksServer broadWorksServer) Retrieves this object with minimal setup.Optional<@Valid HolidaySchedule>Optional<@Valid AnnouncementFileLevelKey>Optional<@Valid AnnouncementFileLevelKey>setAfterHoursMenu(AutoAttendantModifyMenu20 afterHoursMenu) setBusinessHours(TimeSchedule businessHours) setBusinessHoursMenu(AutoAttendantModifyMenu20 businessHoursMenu) setEnableVideo(Boolean enableVideo) setExtensionDialingScope(AutoAttendantDialingScope extensionDialingScope) setFirstDigitTimeoutSeconds(Integer firstDigitTimeoutSeconds) setHolidayMenu(AutoAttendantModifyMenu20 holidayMenu) setHolidaySchedule(HolidaySchedule holidaySchedule) setIsActive(Boolean isActive) setNameDialingEntries(AutoAttendantNameDialingEntry nameDialingEntries) setNameDialingScope(AutoAttendantDialingScope nameDialingScope) setNetworkClassOfService(String networkClassOfService) setServiceInstanceProfile(ServiceInstanceModifyProfile serviceInstanceProfile) setTransferToOperatorAnnouncementSelection(AnnouncementSelection transferToOperatorAnnouncementSelection) setTransferToOperatorAudioFile(AnnouncementFileLevelKey transferToOperatorAudioFile) setTransferToOperatorVideoFile(AnnouncementFileLevelKey transferToOperatorVideoFile) setUnassignPhoneNumbers(UnassignPhoneNumbersLevel unassignPhoneNumbers) setUser(AutoAttendant user) 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
-
Field Details
-
user
-
unassignPhoneNumbers
-
addPhoneNumberToGroup
-
serviceInstanceProfile
-
firstDigitTimeoutSeconds
-
transferToOperatorAnnouncementSelection
-
transferToOperatorAudioFile
-
transferToOperatorVideoFile
-
enableVideo
-
businessHours
-
holidaySchedule
-
extensionDialingScope
-
nameDialingScope
-
nameDialingEntries
-
businessHoursMenu
-
afterHoursMenu
-
holidayMenu
-
networkClassOfService
-
serviceList
-
isActive
-
-
Constructor Details
-
GroupAutoAttendantConsolidatedModifyInstanceRequest
public GroupAutoAttendantConsolidatedModifyInstanceRequest() -
GroupAutoAttendantConsolidatedModifyInstanceRequest
-
-
Method Details
-
setUser
public AutoAttendant.GroupAutoAttendantConsolidatedModifyInstanceRequest setUser(AutoAttendant user) -
getAutoAttendant
-
setUnassignPhoneNumbers
public AutoAttendant.GroupAutoAttendantConsolidatedModifyInstanceRequest setUnassignPhoneNumbers(UnassignPhoneNumbersLevel unassignPhoneNumbers) -
getUnassignPhoneNumbers
-
setFlagAddPhoneNumberToGroup
public AutoAttendant.GroupAutoAttendantConsolidatedModifyInstanceRequest setFlagAddPhoneNumberToGroup() -
addPhoneNumberToGroupFlagExist
public boolean addPhoneNumberToGroupFlagExist() -
getAddPhoneNumberToGroup
-
setServiceInstanceProfile
public AutoAttendant.GroupAutoAttendantConsolidatedModifyInstanceRequest setServiceInstanceProfile(ServiceInstanceModifyProfile serviceInstanceProfile) -
getServiceInstanceProfile
-
setFirstDigitTimeoutSeconds
public AutoAttendant.GroupAutoAttendantConsolidatedModifyInstanceRequest setFirstDigitTimeoutSeconds(Integer firstDigitTimeoutSeconds) -
getFirstDigitTimeoutSeconds
-
setTransferToOperatorAnnouncementSelection
public AutoAttendant.GroupAutoAttendantConsolidatedModifyInstanceRequest setTransferToOperatorAnnouncementSelection(AnnouncementSelection transferToOperatorAnnouncementSelection) -
getTransferToOperatorAnnouncementSelection
-
unsetTransferToOperatorAudioFile
public AutoAttendant.GroupAutoAttendantConsolidatedModifyInstanceRequest unsetTransferToOperatorAudioFile() -
setTransferToOperatorAudioFile
public AutoAttendant.GroupAutoAttendantConsolidatedModifyInstanceRequest setTransferToOperatorAudioFile(AnnouncementFileLevelKey transferToOperatorAudioFile) -
getTransferToOperatorAudioFile
-
unsetTransferToOperatorVideoFile
public AutoAttendant.GroupAutoAttendantConsolidatedModifyInstanceRequest unsetTransferToOperatorVideoFile() -
setTransferToOperatorVideoFile
public AutoAttendant.GroupAutoAttendantConsolidatedModifyInstanceRequest setTransferToOperatorVideoFile(AnnouncementFileLevelKey transferToOperatorVideoFile) -
getTransferToOperatorVideoFile
-
setEnableVideo
public AutoAttendant.GroupAutoAttendantConsolidatedModifyInstanceRequest setEnableVideo(Boolean enableVideo) -
getEnableVideo
-
unsetBusinessHours
-
setBusinessHours
public AutoAttendant.GroupAutoAttendantConsolidatedModifyInstanceRequest setBusinessHours(TimeSchedule businessHours) -
getBusinessHours
-
unsetHolidaySchedule
-
setHolidaySchedule
public AutoAttendant.GroupAutoAttendantConsolidatedModifyInstanceRequest setHolidaySchedule(HolidaySchedule holidaySchedule) -
getHolidaySchedule
-
setExtensionDialingScope
public AutoAttendant.GroupAutoAttendantConsolidatedModifyInstanceRequest setExtensionDialingScope(AutoAttendantDialingScope extensionDialingScope) -
getExtensionDialingScope
-
setNameDialingScope
public AutoAttendant.GroupAutoAttendantConsolidatedModifyInstanceRequest setNameDialingScope(AutoAttendantDialingScope nameDialingScope) -
getNameDialingScope
-
setNameDialingEntries
public AutoAttendant.GroupAutoAttendantConsolidatedModifyInstanceRequest setNameDialingEntries(AutoAttendantNameDialingEntry nameDialingEntries) -
getNameDialingEntries
-
setBusinessHoursMenu
public AutoAttendant.GroupAutoAttendantConsolidatedModifyInstanceRequest setBusinessHoursMenu(AutoAttendantModifyMenu20 businessHoursMenu) -
getBusinessHoursMenu
-
setAfterHoursMenu
public AutoAttendant.GroupAutoAttendantConsolidatedModifyInstanceRequest setAfterHoursMenu(AutoAttendantModifyMenu20 afterHoursMenu) -
getAfterHoursMenu
-
setHolidayMenu
public AutoAttendant.GroupAutoAttendantConsolidatedModifyInstanceRequest setHolidayMenu(AutoAttendantModifyMenu20 holidayMenu) -
getHolidayMenu
-
setNetworkClassOfService
public AutoAttendant.GroupAutoAttendantConsolidatedModifyInstanceRequest setNetworkClassOfService(String networkClassOfService) -
getNetworkClassOfService
-
unsetServiceList
-
setServiceList
public AutoAttendant.GroupAutoAttendantConsolidatedModifyInstanceRequest setServiceList(ReplacementConsolidatedUserServiceAssignmentList serviceList) -
getServiceList
-
setIsActive
public AutoAttendant.GroupAutoAttendantConsolidatedModifyInstanceRequest setIsActive(Boolean isActive) -
getIsActive
-
getEmptyObject
public static AutoAttendant.GroupAutoAttendantConsolidatedModifyInstanceRequest 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:
formRequestin classRequest<DefaultResponse>
-