co.ecg.alpaca.toolkit.generated.services

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

@GwtIncompatible
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, and denyCallTerminiations 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

Fields

Modifier and Type	Field and Description
protected Boolean	alertAgentCalls
protected Boolean	alertClickToDialCalls
protected Boolean	alertGroupPagingCalls
protected Boolean	broadworksCallControl
protected Boolean	denyCallOriginations
protected Boolean	denyCallTerminations
protected com.google.common.base.Optional<String>	description
protected BroadWorksMobilityPhoneToRing	devicesToRing
protected Boolean	enableAlerting
protected Boolean	enableCallAnchoring
protected Boolean	enableDiversionInhibitor
protected com.google.common.base.Optional<ScheduleGlobalKey>	holidaySchedule
protected Boolean	includeBroadworksAnywhere
protected Boolean	includeExecutiveAssistant
protected Boolean	includeSharedCallAppearance
protected Boolean	isPrimary
protected String	mobileNumber
protected com.google.common.base.Optional<BroadWorksMobilityAlertingMobileNumberReplacementList>	mobileNumbersAlerted
protected Boolean	requireAnswerConfirmation
protected com.google.common.base.Optional<ScheduleGlobalKey>	timeSchedule
protected Boolean	useMobilityCallingLineID
protected BroadWorksUser	user
protected BroadWorksMobilityUserSettingLevel	useSettingLevel

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

log

Constructor Summary

Constructors

Constructor and Description
UserBroadWorksMobilityMobileIdentityModifyRequest(BroadWorksUser user, String mobileNumber)

Method Summary

Modifier and Type	Method and Description
void	formRequest() Forms the XML Document for this Request Object.
Boolean	getAlertAgentCalls()
Boolean	getAlertClickToDialCalls()
Boolean	getAlertGroupPagingCalls()
Boolean	getBroadworksCallControl()
BroadWorksUser	getBroadWorksUser()
Boolean	getDenyCallOriginations()
Boolean	getDenyCallTerminations()
com.google.common.base.Optional<String>	getDescription()
BroadWorksMobilityPhoneToRing	getDevicesToRing()
static UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityModifyRequest	getEmptyObject(BroadWorksServer broadWorksServer) Retrieves this object with minimal setup.
Boolean	getEnableAlerting()
Boolean	getEnableCallAnchoring()
Boolean	getEnableDiversionInhibitor()
com.google.common.base.Optional<ScheduleGlobalKey>	getHolidaySchedule()
Boolean	getIncludeBroadworksAnywhere()
Boolean	getIncludeExecutiveAssistant()
Boolean	getIncludeSharedCallAppearance()
Boolean	getIsPrimary()
String	getMobileNumber()
com.google.common.base.Optional<BroadWorksMobilityAlertingMobileNumberReplacementList>	getMobileNumbersAlerted()
Boolean	getRequireAnswerConfirmation()
com.google.common.base.Optional<ScheduleGlobalKey>	getTimeSchedule()
Boolean	getUseMobilityCallingLineID()
BroadWorksMobilityUserSettingLevel	getUseSettingLevel()
UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityModifyRequest	setAlertAgentCalls(Boolean alertAgentCalls)
UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityModifyRequest	setAlertClickToDialCalls(Boolean alertClickToDialCalls)
UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityModifyRequest	setAlertGroupPagingCalls(Boolean alertGroupPagingCalls)
UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityModifyRequest	setBroadworksCallControl(Boolean broadworksCallControl)
UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityModifyRequest	setDenyCallOriginations(Boolean denyCallOriginations)
UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityModifyRequest	setDenyCallTerminations(Boolean denyCallTerminations)
UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityModifyRequest	setDescription(String description)
UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityModifyRequest	setDevicesToRing(BroadWorksMobilityPhoneToRing devicesToRing)
UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityModifyRequest	setEnableAlerting(Boolean enableAlerting)
UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityModifyRequest	setEnableCallAnchoring(Boolean enableCallAnchoring)
UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityModifyRequest	setEnableDiversionInhibitor(Boolean enableDiversionInhibitor)
UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityModifyRequest	setHolidaySchedule(ScheduleGlobalKey holidaySchedule)
UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityModifyRequest	setIncludeBroadworksAnywhere(Boolean includeBroadworksAnywhere)
UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityModifyRequest	setIncludeExecutiveAssistant(Boolean includeExecutiveAssistant)
UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityModifyRequest	setIncludeSharedCallAppearance(Boolean includeSharedCallAppearance)
UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityModifyRequest	setIsPrimary(Boolean isPrimary)
UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityModifyRequest	setMobileNumber(String mobileNumber)
UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityModifyRequest	setMobileNumbersAlerted(BroadWorksMobilityAlertingMobileNumberReplacementList mobileNumbersAlerted)
UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityModifyRequest	setRequireAnswerConfirmation(Boolean requireAnswerConfirmation)
UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityModifyRequest	setTimeSchedule(ScheduleGlobalKey timeSchedule)
UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityModifyRequest	setUseMobilityCallingLineID(Boolean useMobilityCallingLineID)
UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityModifyRequest	setUser(BroadWorksUser user)
UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityModifyRequest	setUseSettingLevel(BroadWorksMobilityUserSettingLevel useSettingLevel)

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

appendChild, appendChild, appendChild, asyncFire, createElement, createNilElement, createTextElement, fire, fire, getBroadWorksServer, getCacheString, getCommandElement, getCommandType, getDomDocument, getId, getOCSProtocol, getRequestTimeoutMillis, getResponseClass, getRootElement, getValidationErrorsAsString, isMemberOfBundle, isValid, setBroadWorksServer, setCommandElement, setCommandType, setDomDocument, setMemberOfBundle, setRequestId, setRequestTimeoutMillis, setResponseClass, setRootElement, toString, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

user

@NotNull
protected transient BroadWorksUser user

mobileNumber

@NotNull
 @Size(min=1,
      max=23)
protected String mobileNumber

description

protected com.google.common.base.Optional<String> description

isPrimary

protected Boolean isPrimary

enableAlerting

protected Boolean enableAlerting

alertAgentCalls

protected Boolean alertAgentCalls

alertClickToDialCalls

protected Boolean alertClickToDialCalls

alertGroupPagingCalls

protected Boolean alertGroupPagingCalls

useMobilityCallingLineID

protected Boolean useMobilityCallingLineID

enableDiversionInhibitor

protected Boolean enableDiversionInhibitor

requireAnswerConfirmation

protected Boolean requireAnswerConfirmation

broadworksCallControl

protected Boolean broadworksCallControl

useSettingLevel

protected BroadWorksMobilityUserSettingLevel useSettingLevel

denyCallOriginations

protected Boolean denyCallOriginations

denyCallTerminations

protected Boolean denyCallTerminations

devicesToRing

protected BroadWorksMobilityPhoneToRing devicesToRing

includeSharedCallAppearance

protected Boolean includeSharedCallAppearance

includeBroadworksAnywhere

protected Boolean includeBroadworksAnywhere

includeExecutiveAssistant

protected Boolean includeExecutiveAssistant

mobileNumbersAlerted

protected com.google.common.base.Optional<BroadWorksMobilityAlertingMobileNumberReplacementList> mobileNumbersAlerted

enableCallAnchoring

protected Boolean enableCallAnchoring

timeSchedule

protected com.google.common.base.Optional<ScheduleGlobalKey> timeSchedule

holidaySchedule

protected com.google.common.base.Optional<ScheduleGlobalKey> holidaySchedule

Constructor Detail

UserBroadWorksMobilityMobileIdentityModifyRequest

public UserBroadWorksMobilityMobileIdentityModifyRequest(BroadWorksUser user,
                                                         String mobileNumber)

Method Detail

setUser

public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityModifyRequest setUser(BroadWorksUser user)

getBroadWorksUser

public BroadWorksUser getBroadWorksUser()

setMobileNumber

public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityModifyRequest setMobileNumber(String mobileNumber)

getMobileNumber

public String getMobileNumber()

setDescription

public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityModifyRequest setDescription(String description)

getDescription

public com.google.common.base.Optional<String> getDescription()

setIsPrimary

public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityModifyRequest setIsPrimary(Boolean isPrimary)

getIsPrimary

public Boolean getIsPrimary()

setEnableAlerting

public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityModifyRequest setEnableAlerting(Boolean enableAlerting)

getEnableAlerting

public Boolean getEnableAlerting()

setAlertAgentCalls

public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityModifyRequest setAlertAgentCalls(Boolean alertAgentCalls)

getAlertAgentCalls

public Boolean getAlertAgentCalls()

setAlertClickToDialCalls

public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityModifyRequest setAlertClickToDialCalls(Boolean alertClickToDialCalls)

getAlertClickToDialCalls

public Boolean getAlertClickToDialCalls()

setAlertGroupPagingCalls

public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityModifyRequest setAlertGroupPagingCalls(Boolean alertGroupPagingCalls)

getAlertGroupPagingCalls

public Boolean getAlertGroupPagingCalls()

setUseMobilityCallingLineID

public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityModifyRequest setUseMobilityCallingLineID(Boolean useMobilityCallingLineID)

getUseMobilityCallingLineID

public Boolean getUseMobilityCallingLineID()

setEnableDiversionInhibitor

public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityModifyRequest setEnableDiversionInhibitor(Boolean enableDiversionInhibitor)

getEnableDiversionInhibitor

public Boolean getEnableDiversionInhibitor()

setRequireAnswerConfirmation

public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityModifyRequest setRequireAnswerConfirmation(Boolean requireAnswerConfirmation)

getRequireAnswerConfirmation

public Boolean getRequireAnswerConfirmation()

setBroadworksCallControl

public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityModifyRequest setBroadworksCallControl(Boolean broadworksCallControl)

getBroadworksCallControl

public Boolean getBroadworksCallControl()

setUseSettingLevel

public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityModifyRequest setUseSettingLevel(BroadWorksMobilityUserSettingLevel useSettingLevel)

getUseSettingLevel

public BroadWorksMobilityUserSettingLevel getUseSettingLevel()

setDenyCallOriginations

public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityModifyRequest setDenyCallOriginations(Boolean denyCallOriginations)

getDenyCallOriginations

public Boolean getDenyCallOriginations()

setDenyCallTerminations

public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityModifyRequest setDenyCallTerminations(Boolean denyCallTerminations)

getDenyCallTerminations

public Boolean getDenyCallTerminations()

setDevicesToRing

public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityModifyRequest setDevicesToRing(BroadWorksMobilityPhoneToRing devicesToRing)

getDevicesToRing

public BroadWorksMobilityPhoneToRing getDevicesToRing()

setIncludeSharedCallAppearance

public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityModifyRequest setIncludeSharedCallAppearance(Boolean includeSharedCallAppearance)

getIncludeSharedCallAppearance

public Boolean getIncludeSharedCallAppearance()

setIncludeBroadworksAnywhere

public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityModifyRequest setIncludeBroadworksAnywhere(Boolean includeBroadworksAnywhere)

getIncludeBroadworksAnywhere

public Boolean getIncludeBroadworksAnywhere()

setIncludeExecutiveAssistant

public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityModifyRequest setIncludeExecutiveAssistant(Boolean includeExecutiveAssistant)

getIncludeExecutiveAssistant

public Boolean getIncludeExecutiveAssistant()

setMobileNumbersAlerted

public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityModifyRequest setMobileNumbersAlerted(BroadWorksMobilityAlertingMobileNumberReplacementList mobileNumbersAlerted)

getMobileNumbersAlerted

public com.google.common.base.Optional<BroadWorksMobilityAlertingMobileNumberReplacementList> getMobileNumbersAlerted()

setEnableCallAnchoring

public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityModifyRequest setEnableCallAnchoring(Boolean enableCallAnchoring)

getEnableCallAnchoring

public Boolean getEnableCallAnchoring()

setTimeSchedule

public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityModifyRequest setTimeSchedule(ScheduleGlobalKey timeSchedule)

getTimeSchedule

public com.google.common.base.Optional<ScheduleGlobalKey> getTimeSchedule()

setHolidaySchedule

public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityModifyRequest setHolidaySchedule(ScheduleGlobalKey holidaySchedule)

getHolidaySchedule

public com.google.common.base.Optional<ScheduleGlobalKey> getHolidaySchedule()

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 class Request<DefaultResponse>