Class UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedModifyRequest
java.lang.Object
co.ecg.alpaca.toolkit.messaging.request.Request<DefaultResponse>
co.ecg.alpaca.toolkit.generated.services.UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedModifyRequest
- Enclosing class:
- UserBroadWorksMobility
@Choice(minOccurs=0,value={@ChoiceGroup("accessDeviceEndpoint"),@ChoiceGroup("outboundAlternateNumber")})
public static class UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedModifyRequest
extends Request<DefaultResponse>
Modify the settings for one of the user's BroadWorks Mobility mobile Identities. The response is either a SuccessResponse or an ErrorResponse. If deleteExistingDevices is set to true, when the devices for the endpoint are changed, devices with no more endpoint will be deleted if the command is executed with the correct privilege. The request fails when enableAlerting or timeSchedule or holidaySchedule are included in the request when the use mobile identity call anchoring controls for the user is disabled. The description, enableAlerting, alertAgentCalls, alertClickToDialCalls, alertGroupPagingCalls, useMobilityCallingLineID, enableDiversionInhibitor, requireAnswerConfirmation, broadworksCallControl, devicesToRing, includeSharedCallAppearance, includeBroadworksAnywhere, includeExecutiveAssistance, mobileNumberAlerted, enableCallAnchoring, timeSchedule and holidaySchedule parameters require an authorization level of User for modification when the BroadWorks Mobility service is on. The isPrimary, useSettingLevel, denyCallOrigination, denyCallTerminations, accessDeviceEndpoint, outboundAlternateNumber, enableDirectRouting, markCDRAsEnterpriseGroupCalls and networkTranslationIndex parameters require an authorization level of Group for modification.
- 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 Optional<@Valid ConsolidatedSharedCallAppearanceAccessDeviceMultipleIdentityEndpoint>
protected Boolean
protected Boolean
protected Boolean
protected Boolean
protected @AssertTrue Boolean
protected Boolean
protected Boolean
protected BroadWorksMobilityPhoneToRing
protected Boolean
protected Boolean
protected Boolean
protected Boolean
protected Optional<@Valid ScheduleGlobalKey>
protected Boolean
protected Boolean
protected Boolean
protected Boolean
protected Boolean
protected @NotNull @Size(min=1,max=23) String
protected Optional<@Valid BroadWorksMobilityAlertingMobileNumberReplacementList>
protected Boolean
protected Optional<@Valid ScheduleGlobalKey>
protected Boolean
protected Boolean
protected @NotNull @Valid BroadWorksUser
protected BroadWorksMobilityUserSettingLevel
-
Constructor Summary
ConstructorsConstructorDescriptionUserBroadWorksMobilityMobileIdentityConsolidatedModifyRequest
(BroadWorksUser user, String mobileNumber) -
Method Summary
Modifier and TypeMethodDescriptionboolean
void
Forms the XML Document for this Request Object.getEmptyObject
(BroadWorksServer broadWorksServer) Retrieves this object with minimal setup.Optional<@Valid ScheduleGlobalKey>
Optional<@Valid ScheduleGlobalKey>
setAccessDeviceEndpoint
(ConsolidatedSharedCallAppearanceAccessDeviceMultipleIdentityEndpoint accessDeviceEndpoint) setAlertAgentCalls
(Boolean alertAgentCalls) setAlertClickToDialCalls
(Boolean alertClickToDialCalls) setAlertGroupPagingCalls
(Boolean alertGroupPagingCalls) setBroadworksCallControl
(Boolean broadworksCallControl) setDenyCallOriginations
(Boolean denyCallOriginations) setDenyCallTerminations
(Boolean denyCallTerminations) setDescription
(String description) setDevicesToRing
(BroadWorksMobilityPhoneToRing devicesToRing) setEnableAlerting
(Boolean enableAlerting) setEnableCallAnchoring
(Boolean enableCallAnchoring) setEnableDirectRouting
(Boolean enableDirectRouting) setEnableDiversionInhibitor
(Boolean enableDiversionInhibitor) setHolidaySchedule
(ScheduleGlobalKey holidaySchedule) setIncludeBroadworksAnywhere
(Boolean includeBroadworksAnywhere) setIncludeExecutiveAssistant
(Boolean includeExecutiveAssistant) setIncludeSharedCallAppearance
(Boolean includeSharedCallAppearance) setIsPrimary
(Boolean isPrimary) setMarkCDRAsEnterpriseGroupCalls
(Boolean markCDRAsEnterpriseGroupCalls) setMobileNumber
(String mobileNumber) setMobileNumbersAlerted
(BroadWorksMobilityAlertingMobileNumberReplacementList mobileNumbersAlerted) setNetworkTranslationIndex
(String networkTranslationIndex) setOutboundAlternateNumber
(String outboundAlternateNumber) setRequireAnswerConfirmation
(Boolean requireAnswerConfirmation) setTimeSchedule
(ScheduleGlobalKey timeSchedule) setUseMobilityCallingLineID
(Boolean useMobilityCallingLineID) setUseMobilityConnectedIdentity
(Boolean useMobilityConnectedIdentity) setUser
(BroadWorksUser user) setUseSettingLevel
(BroadWorksMobilityUserSettingLevel useSettingLevel) 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
-
mobileNumber
-
deleteExistingDevices
-
description
-
isPrimary
-
enableAlerting
-
alertAgentCalls
-
alertClickToDialCalls
-
alertGroupPagingCalls
-
useMobilityCallingLineID
-
enableDiversionInhibitor
-
requireAnswerConfirmation
-
broadworksCallControl
-
useSettingLevel
-
denyCallOriginations
-
denyCallTerminations
-
devicesToRing
-
includeBroadworksAnywhere
-
includeExecutiveAssistant
-
mobileNumbersAlerted
protected Optional<@Valid BroadWorksMobilityAlertingMobileNumberReplacementList> mobileNumbersAlerted -
enableCallAnchoring
-
timeSchedule
-
holidaySchedule
-
accessDeviceEndpoint
protected Optional<@Valid ConsolidatedSharedCallAppearanceAccessDeviceMultipleIdentityEndpoint> accessDeviceEndpoint -
outboundAlternateNumber
-
enableDirectRouting
-
markCDRAsEnterpriseGroupCalls
-
useMobilityConnectedIdentity
-
networkTranslationIndex
-
-
Constructor Details
-
UserBroadWorksMobilityMobileIdentityConsolidatedModifyRequest
public UserBroadWorksMobilityMobileIdentityConsolidatedModifyRequest() -
UserBroadWorksMobilityMobileIdentityConsolidatedModifyRequest
public UserBroadWorksMobilityMobileIdentityConsolidatedModifyRequest(BroadWorksUser user, String mobileNumber)
-
-
Method Details
-
setUser
-
getBroadWorksUser
-
setMobileNumber
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedModifyRequest setMobileNumber(String mobileNumber) -
getMobileNumber
-
setFlagDeleteExistingDevices
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedModifyRequest setFlagDeleteExistingDevices() -
deleteExistingDevicesFlagExist
public boolean deleteExistingDevicesFlagExist() -
getDeleteExistingDevices
-
unsetDescription
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedModifyRequest unsetDescription() -
setDescription
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedModifyRequest setDescription(String description) -
getDescription
-
setIsPrimary
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedModifyRequest setIsPrimary(Boolean isPrimary) -
getIsPrimary
-
setEnableAlerting
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedModifyRequest setEnableAlerting(Boolean enableAlerting) -
getEnableAlerting
-
setAlertAgentCalls
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedModifyRequest setAlertAgentCalls(Boolean alertAgentCalls) -
getAlertAgentCalls
-
setAlertClickToDialCalls
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedModifyRequest setAlertClickToDialCalls(Boolean alertClickToDialCalls) -
getAlertClickToDialCalls
-
setAlertGroupPagingCalls
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedModifyRequest setAlertGroupPagingCalls(Boolean alertGroupPagingCalls) -
getAlertGroupPagingCalls
-
setUseMobilityCallingLineID
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedModifyRequest setUseMobilityCallingLineID(Boolean useMobilityCallingLineID) -
getUseMobilityCallingLineID
-
setEnableDiversionInhibitor
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedModifyRequest setEnableDiversionInhibitor(Boolean enableDiversionInhibitor) -
getEnableDiversionInhibitor
-
setRequireAnswerConfirmation
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedModifyRequest setRequireAnswerConfirmation(Boolean requireAnswerConfirmation) -
getRequireAnswerConfirmation
-
setBroadworksCallControl
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedModifyRequest setBroadworksCallControl(Boolean broadworksCallControl) -
getBroadworksCallControl
-
setUseSettingLevel
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedModifyRequest setUseSettingLevel(BroadWorksMobilityUserSettingLevel useSettingLevel) -
getUseSettingLevel
-
setDenyCallOriginations
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedModifyRequest setDenyCallOriginations(Boolean denyCallOriginations) -
getDenyCallOriginations
-
setDenyCallTerminations
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedModifyRequest setDenyCallTerminations(Boolean denyCallTerminations) -
getDenyCallTerminations
-
setDevicesToRing
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedModifyRequest setDevicesToRing(BroadWorksMobilityPhoneToRing devicesToRing) -
getDevicesToRing
-
setIncludeBroadworksAnywhere
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedModifyRequest setIncludeBroadworksAnywhere(Boolean includeBroadworksAnywhere) -
getIncludeBroadworksAnywhere
-
setIncludeExecutiveAssistant
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedModifyRequest setIncludeExecutiveAssistant(Boolean includeExecutiveAssistant) -
getIncludeExecutiveAssistant
-
unsetMobileNumbersAlerted
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedModifyRequest unsetMobileNumbersAlerted() -
setMobileNumbersAlerted
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedModifyRequest setMobileNumbersAlerted(BroadWorksMobilityAlertingMobileNumberReplacementList mobileNumbersAlerted) -
getMobileNumbersAlerted
public Optional<@Valid BroadWorksMobilityAlertingMobileNumberReplacementList> getMobileNumbersAlerted() -
setEnableCallAnchoring
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedModifyRequest setEnableCallAnchoring(Boolean enableCallAnchoring) -
getEnableCallAnchoring
-
unsetTimeSchedule
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedModifyRequest unsetTimeSchedule() -
setTimeSchedule
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedModifyRequest setTimeSchedule(ScheduleGlobalKey timeSchedule) -
getTimeSchedule
-
unsetHolidaySchedule
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedModifyRequest unsetHolidaySchedule() -
setHolidaySchedule
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedModifyRequest setHolidaySchedule(ScheduleGlobalKey holidaySchedule) -
getHolidaySchedule
-
unsetAccessDeviceEndpoint
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedModifyRequest unsetAccessDeviceEndpoint() -
getAccessDeviceEndpoint
public Optional<@Valid ConsolidatedSharedCallAppearanceAccessDeviceMultipleIdentityEndpoint> getAccessDeviceEndpoint() -
unsetOutboundAlternateNumber
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedModifyRequest unsetOutboundAlternateNumber() -
setOutboundAlternateNumber
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedModifyRequest setOutboundAlternateNumber(String outboundAlternateNumber) -
getOutboundAlternateNumber
-
setEnableDirectRouting
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedModifyRequest setEnableDirectRouting(Boolean enableDirectRouting) -
getEnableDirectRouting
-
setMarkCDRAsEnterpriseGroupCalls
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedModifyRequest setMarkCDRAsEnterpriseGroupCalls(Boolean markCDRAsEnterpriseGroupCalls) -
getMarkCDRAsEnterpriseGroupCalls
-
setUseMobilityConnectedIdentity
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedModifyRequest setUseMobilityConnectedIdentity(Boolean useMobilityConnectedIdentity) -
getUseMobilityConnectedIdentity
-
unsetNetworkTranslationIndex
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedModifyRequest unsetNetworkTranslationIndex() -
setNetworkTranslationIndex
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedModifyRequest setNetworkTranslationIndex(String networkTranslationIndex) -
getNetworkTranslationIndex
-
getEmptyObject
public static UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedModifyRequest 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 classRequest<DefaultResponse>
-