Class UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityModifyRequest
java.lang.Object
co.ecg.alpaca.toolkit.messaging.request.Request<DefaultResponse>
co.ecg.alpaca.toolkit.generated.services.UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityModifyRequest
- Enclosing class:
- UserBroadWorksMobility
@Choice(minOccurs=0,value={@ChoiceGroup("accessDeviceEndpoint"),@ChoiceGroup("outboundAlternateNumber")})
public static class UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityModifyRequest
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. The request fails when enableAlerting or timeSchedule or holidaySchedule are included in the request when the user’s use mobile identity call anchoring controls 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, denyCallTerminiations, accessDeviceEndpoint, outboundAlternateNumber, enableDirectRouting and markCDRAsEnterpriseGroupCalls 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 AccessDeviceEndpointModify>
protected Boolean
protected Boolean
protected Boolean
protected 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 @NotNull @Valid BroadWorksUser
protected BroadWorksMobilityUserSettingLevel
-
Constructor Summary
ConstructorsConstructorDescriptionUserBroadWorksMobilityMobileIdentityModifyRequest
(BroadWorksUser user, String mobileNumber) -
Method Summary
Modifier and TypeMethodDescriptionvoid
Forms the XML Document for this Request Object.Optional<@Valid AccessDeviceEndpointModify>
getEmptyObject
(BroadWorksServer broadWorksServer) Retrieves this object with minimal setup.Optional<@Valid ScheduleGlobalKey>
Optional<@Valid ScheduleGlobalKey>
setAccessDeviceEndpoint
(AccessDeviceEndpointModify 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) setOutboundAlternateNumber
(String outboundAlternateNumber) setRequireAnswerConfirmation
(Boolean requireAnswerConfirmation) setTimeSchedule
(ScheduleGlobalKey timeSchedule) setUseMobilityCallingLineID
(Boolean useMobilityCallingLineID) 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
-
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
-
outboundAlternateNumber
-
enableDirectRouting
-
markCDRAsEnterpriseGroupCalls
-
-
Constructor Details
-
UserBroadWorksMobilityMobileIdentityModifyRequest
public UserBroadWorksMobilityMobileIdentityModifyRequest() -
UserBroadWorksMobilityMobileIdentityModifyRequest
-
-
Method Details
-
setUser
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityModifyRequest setUser(BroadWorksUser user) -
getBroadWorksUser
-
setMobileNumber
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityModifyRequest setMobileNumber(String mobileNumber) -
getMobileNumber
-
unsetDescription
-
setDescription
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityModifyRequest setDescription(String description) -
getDescription
-
setIsPrimary
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityModifyRequest setIsPrimary(Boolean isPrimary) -
getIsPrimary
-
setEnableAlerting
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityModifyRequest setEnableAlerting(Boolean enableAlerting) -
getEnableAlerting
-
setAlertAgentCalls
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityModifyRequest setAlertAgentCalls(Boolean alertAgentCalls) -
getAlertAgentCalls
-
setAlertClickToDialCalls
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityModifyRequest setAlertClickToDialCalls(Boolean alertClickToDialCalls) -
getAlertClickToDialCalls
-
setAlertGroupPagingCalls
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityModifyRequest setAlertGroupPagingCalls(Boolean alertGroupPagingCalls) -
getAlertGroupPagingCalls
-
setUseMobilityCallingLineID
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityModifyRequest setUseMobilityCallingLineID(Boolean useMobilityCallingLineID) -
getUseMobilityCallingLineID
-
setEnableDiversionInhibitor
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityModifyRequest setEnableDiversionInhibitor(Boolean enableDiversionInhibitor) -
getEnableDiversionInhibitor
-
setRequireAnswerConfirmation
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityModifyRequest setRequireAnswerConfirmation(Boolean requireAnswerConfirmation) -
getRequireAnswerConfirmation
-
setBroadworksCallControl
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityModifyRequest setBroadworksCallControl(Boolean broadworksCallControl) -
getBroadworksCallControl
-
setUseSettingLevel
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityModifyRequest setUseSettingLevel(BroadWorksMobilityUserSettingLevel useSettingLevel) -
getUseSettingLevel
-
setDenyCallOriginations
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityModifyRequest setDenyCallOriginations(Boolean denyCallOriginations) -
getDenyCallOriginations
-
setDenyCallTerminations
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityModifyRequest setDenyCallTerminations(Boolean denyCallTerminations) -
getDenyCallTerminations
-
setDevicesToRing
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityModifyRequest setDevicesToRing(BroadWorksMobilityPhoneToRing devicesToRing) -
getDevicesToRing
-
setIncludeBroadworksAnywhere
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityModifyRequest setIncludeBroadworksAnywhere(Boolean includeBroadworksAnywhere) -
getIncludeBroadworksAnywhere
-
setIncludeExecutiveAssistant
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityModifyRequest setIncludeExecutiveAssistant(Boolean includeExecutiveAssistant) -
getIncludeExecutiveAssistant
-
unsetMobileNumbersAlerted
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityModifyRequest unsetMobileNumbersAlerted() -
setMobileNumbersAlerted
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityModifyRequest setMobileNumbersAlerted(BroadWorksMobilityAlertingMobileNumberReplacementList mobileNumbersAlerted) -
getMobileNumbersAlerted
public Optional<@Valid BroadWorksMobilityAlertingMobileNumberReplacementList> getMobileNumbersAlerted() -
setEnableCallAnchoring
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityModifyRequest setEnableCallAnchoring(Boolean enableCallAnchoring) -
getEnableCallAnchoring
-
unsetTimeSchedule
-
setTimeSchedule
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityModifyRequest setTimeSchedule(ScheduleGlobalKey timeSchedule) -
getTimeSchedule
-
unsetHolidaySchedule
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityModifyRequest unsetHolidaySchedule() -
setHolidaySchedule
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityModifyRequest setHolidaySchedule(ScheduleGlobalKey holidaySchedule) -
getHolidaySchedule
-
unsetAccessDeviceEndpoint
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityModifyRequest unsetAccessDeviceEndpoint() -
setAccessDeviceEndpoint
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityModifyRequest setAccessDeviceEndpoint(AccessDeviceEndpointModify accessDeviceEndpoint) -
getAccessDeviceEndpoint
-
unsetOutboundAlternateNumber
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityModifyRequest unsetOutboundAlternateNumber() -
setOutboundAlternateNumber
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityModifyRequest setOutboundAlternateNumber(String outboundAlternateNumber) -
getOutboundAlternateNumber
-
setEnableDirectRouting
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityModifyRequest setEnableDirectRouting(Boolean enableDirectRouting) -
getEnableDirectRouting
-
setMarkCDRAsEnterpriseGroupCalls
public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityModifyRequest setMarkCDRAsEnterpriseGroupCalls(Boolean markCDRAsEnterpriseGroupCalls) -
getMarkCDRAsEnterpriseGroupCalls
-
getEmptyObject
public static UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityModifyRequest 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>
-