Package co.ecg.alpaca.toolkit.generated.services

Class UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedAddRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.services.UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedAddRequest

Enclosing class:

UserBroadWorksMobility

@Choice(minOccurs=0,value={@ChoiceGroup("accessDeviceEndpoint"),@ChoiceGroup("outboundAlternateNumber")})
public static class UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedAddRequest
extends Request<DefaultResponse>

Add a mobile identity to the user's list of mobile identities. The response is either a SuccessResponse or an ErrorResponse. The request fails when the devicesToRing is set to Mobile and the mobileNumberAlerted list is empty.

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 @Valid ConsolidatedSharedCallAppearanceAccessDeviceMultipleIdentityEndpointAdd22	accessDeviceEndpoint
protected @NotNull Boolean	alertAgentCalls
protected @NotNull Boolean	alertClickToDialCalls
protected @NotNull Boolean	alertGroupPagingCalls
protected @NotNull Boolean	broadworksCallControl
protected @NotNull Boolean	denyCallOriginations
protected @NotNull Boolean	denyCallTerminations
protected @Size(min=1,max=40) String	description
protected @NotNull BroadWorksMobilityPhoneToRing	devicesToRing
protected @NotNull Boolean	enableAlerting
protected @NotNull Boolean	enableCallAnchoring
protected @NotNull Boolean	enableDirectRouting
protected @NotNull Boolean	enableDiversionInhibitor
protected @Valid ScheduleGlobalKey	holidaySchedule
protected @NotNull Boolean	includeBroadworksAnywhere
protected @NotNull Boolean	includeExecutiveAssistant
protected @NotNull Boolean	includeSharedCallAppearance
protected @NotNull Boolean	isPrimary
protected @NotNull Boolean	markCDRAsEnterpriseGroupCalls
protected @NotNull @Size(min=1,max=23) String	mobileNumber
protected String[]	mobileNumberAlerted
protected @Size(min=1,max=161) String	outboundAlternateNumber
protected @NotNull Boolean	requireAnswerConfirmation
protected @Valid ScheduleGlobalKey	timeSchedule
protected @NotNull Boolean	useMobilityCallingLineID
protected @NotNull @Valid BroadWorksUser	user
protected @NotNull BroadWorksMobilityUserSettingLevel	useSettingLevel

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

log

Constructor Summary

Constructors

Constructor	Description
UserBroadWorksMobilityMobileIdentityConsolidatedAddRequest()
UserBroadWorksMobilityMobileIdentityConsolidatedAddRequest(BroadWorksUser user, String mobileNumber, Boolean isPrimary, Boolean enableAlerting, Boolean alertAgentCalls, Boolean alertClickToDialCalls, Boolean alertGroupPagingCalls, Boolean useMobilityCallingLineID, Boolean enableDiversionInhibitor, Boolean requireAnswerConfirmation, Boolean broadworksCallControl, BroadWorksMobilityUserSettingLevel useSettingLevel, Boolean denyCallOriginations, Boolean denyCallTerminations, BroadWorksMobilityPhoneToRing devicesToRing, Boolean includeSharedCallAppearance, Boolean includeBroadworksAnywhere, Boolean includeExecutiveAssistant, Boolean enableCallAnchoring, Boolean enableDirectRouting, Boolean markCDRAsEnterpriseGroupCalls)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
ConsolidatedSharedCallAppearanceAccessDeviceMultipleIdentityEndpointAdd22	getAccessDeviceEndpoint()
Boolean	getAlertAgentCalls()
Boolean	getAlertClickToDialCalls()
Boolean	getAlertGroupPagingCalls()
Boolean	getBroadworksCallControl()
BroadWorksUser	getBroadWorksUser()
Boolean	getDenyCallOriginations()
Boolean	getDenyCallTerminations()
String	getDescription()
BroadWorksMobilityPhoneToRing	getDevicesToRing()
static UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedAddRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
Boolean	getEnableAlerting()
Boolean	getEnableCallAnchoring()
Boolean	getEnableDirectRouting()
Boolean	getEnableDiversionInhibitor()
ScheduleGlobalKey	getHolidaySchedule()
Boolean	getIncludeBroadworksAnywhere()
Boolean	getIncludeExecutiveAssistant()
Boolean	getIncludeSharedCallAppearance()
Boolean	getIsPrimary()
Boolean	getMarkCDRAsEnterpriseGroupCalls()
String	getMobileNumber()
String[]	getMobileNumberAlerted()
String	getOutboundAlternateNumber()
Boolean	getRequireAnswerConfirmation()
ScheduleGlobalKey	getTimeSchedule()
Boolean	getUseMobilityCallingLineID()
BroadWorksMobilityUserSettingLevel	getUseSettingLevel()
UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedAddRequest	setAccessDeviceEndpoint(ConsolidatedSharedCallAppearanceAccessDeviceMultipleIdentityEndpointAdd22 accessDeviceEndpoint)
UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedAddRequest	setAlertAgentCalls(Boolean alertAgentCalls)
UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedAddRequest	setAlertClickToDialCalls(Boolean alertClickToDialCalls)
UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedAddRequest	setAlertGroupPagingCalls(Boolean alertGroupPagingCalls)
UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedAddRequest	setBroadworksCallControl(Boolean broadworksCallControl)
UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedAddRequest	setDenyCallOriginations(Boolean denyCallOriginations)
UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedAddRequest	setDenyCallTerminations(Boolean denyCallTerminations)
UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedAddRequest	setDescription(String description)
UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedAddRequest	setDevicesToRing(BroadWorksMobilityPhoneToRing devicesToRing)
UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedAddRequest	setEnableAlerting(Boolean enableAlerting)
UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedAddRequest	setEnableCallAnchoring(Boolean enableCallAnchoring)
UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedAddRequest	setEnableDirectRouting(Boolean enableDirectRouting)
UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedAddRequest	setEnableDiversionInhibitor(Boolean enableDiversionInhibitor)
UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedAddRequest	setHolidaySchedule(ScheduleGlobalKey holidaySchedule)
UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedAddRequest	setIncludeBroadworksAnywhere(Boolean includeBroadworksAnywhere)
UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedAddRequest	setIncludeExecutiveAssistant(Boolean includeExecutiveAssistant)
UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedAddRequest	setIncludeSharedCallAppearance(Boolean includeSharedCallAppearance)
UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedAddRequest	setIsPrimary(Boolean isPrimary)
UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedAddRequest	setMarkCDRAsEnterpriseGroupCalls(Boolean markCDRAsEnterpriseGroupCalls)
UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedAddRequest	setMobileNumber(String mobileNumber)
UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedAddRequest	setMobileNumberAlerted(String... mobileNumberAlerted)
UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedAddRequest	setOutboundAlternateNumber(String outboundAlternateNumber)
UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedAddRequest	setRequireAnswerConfirmation(Boolean requireAnswerConfirmation)
UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedAddRequest	setTimeSchedule(ScheduleGlobalKey timeSchedule)
UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedAddRequest	setUseMobilityCallingLineID(Boolean useMobilityCallingLineID)
UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedAddRequest	setUser(BroadWorksUser user)
UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedAddRequest	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

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

user

@NotNull
@Valid
protected transient @NotNull @Valid BroadWorksUser user

mobileNumber

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

description

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

isPrimary

@NotNull
protected @NotNull Boolean isPrimary

enableAlerting

@NotNull
protected @NotNull Boolean enableAlerting

alertAgentCalls

@NotNull
protected @NotNull Boolean alertAgentCalls

alertClickToDialCalls

@NotNull
protected @NotNull Boolean alertClickToDialCalls

alertGroupPagingCalls

@NotNull
protected @NotNull Boolean alertGroupPagingCalls

useMobilityCallingLineID

@NotNull
protected @NotNull Boolean useMobilityCallingLineID

enableDiversionInhibitor

@NotNull
protected @NotNull Boolean enableDiversionInhibitor

requireAnswerConfirmation

@NotNull
protected @NotNull Boolean requireAnswerConfirmation

broadworksCallControl

@NotNull
protected @NotNull Boolean broadworksCallControl

useSettingLevel

@NotNull
protected @NotNull BroadWorksMobilityUserSettingLevel useSettingLevel

denyCallOriginations

@NotNull
protected @NotNull Boolean denyCallOriginations

denyCallTerminations

@NotNull
protected @NotNull Boolean denyCallTerminations

devicesToRing

@NotNull
protected @NotNull BroadWorksMobilityPhoneToRing devicesToRing

includeSharedCallAppearance

@NotNull
protected @NotNull Boolean includeSharedCallAppearance

includeBroadworksAnywhere

@NotNull
protected @NotNull Boolean includeBroadworksAnywhere

includeExecutiveAssistant

@NotNull
protected @NotNull Boolean includeExecutiveAssistant

mobileNumberAlerted

@StringArrayElementSize(min=1,
                        max=23)
protected String[] mobileNumberAlerted

enableCallAnchoring

@NotNull
protected @NotNull Boolean enableCallAnchoring

timeSchedule

@Valid
protected @Valid ScheduleGlobalKey timeSchedule

holidaySchedule

@Valid
protected @Valid ScheduleGlobalKey holidaySchedule

accessDeviceEndpoint

@Valid
protected @Valid ConsolidatedSharedCallAppearanceAccessDeviceMultipleIdentityEndpointAdd22 accessDeviceEndpoint

outboundAlternateNumber

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

enableDirectRouting

@NotNull
protected @NotNull Boolean enableDirectRouting

markCDRAsEnterpriseGroupCalls

@NotNull
protected @NotNull Boolean markCDRAsEnterpriseGroupCalls

Constructor Details

UserBroadWorksMobilityMobileIdentityConsolidatedAddRequest

public UserBroadWorksMobilityMobileIdentityConsolidatedAddRequest()

UserBroadWorksMobilityMobileIdentityConsolidatedAddRequest

public UserBroadWorksMobilityMobileIdentityConsolidatedAddRequest(BroadWorksUser user,
 String mobileNumber,
 Boolean isPrimary,
 Boolean enableAlerting,
 Boolean alertAgentCalls,
 Boolean alertClickToDialCalls,
 Boolean alertGroupPagingCalls,
 Boolean useMobilityCallingLineID,
 Boolean enableDiversionInhibitor,
 Boolean requireAnswerConfirmation,
 Boolean broadworksCallControl,
 BroadWorksMobilityUserSettingLevel useSettingLevel,
 Boolean denyCallOriginations,
 Boolean denyCallTerminations,
 BroadWorksMobilityPhoneToRing devicesToRing,
 Boolean includeSharedCallAppearance,
 Boolean includeBroadworksAnywhere,
 Boolean includeExecutiveAssistant,
 Boolean enableCallAnchoring,
 Boolean enableDirectRouting,
 Boolean markCDRAsEnterpriseGroupCalls)

Method Details

setUser

public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedAddRequest setUser(BroadWorksUser user)

getBroadWorksUser

public BroadWorksUser getBroadWorksUser()

setMobileNumber

public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedAddRequest setMobileNumber(String mobileNumber)

getMobileNumber

public String getMobileNumber()

setDescription

public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedAddRequest setDescription(String description)

getDescription

public String getDescription()

setIsPrimary

public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedAddRequest setIsPrimary(Boolean isPrimary)

getIsPrimary

public Boolean getIsPrimary()

setEnableAlerting

public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedAddRequest setEnableAlerting(Boolean enableAlerting)

getEnableAlerting

public Boolean getEnableAlerting()

setAlertAgentCalls

public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedAddRequest setAlertAgentCalls(Boolean alertAgentCalls)

getAlertAgentCalls

public Boolean getAlertAgentCalls()

setAlertClickToDialCalls

public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedAddRequest setAlertClickToDialCalls(Boolean alertClickToDialCalls)

getAlertClickToDialCalls

public Boolean getAlertClickToDialCalls()

setAlertGroupPagingCalls

public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedAddRequest setAlertGroupPagingCalls(Boolean alertGroupPagingCalls)

getAlertGroupPagingCalls

public Boolean getAlertGroupPagingCalls()

setUseMobilityCallingLineID

public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedAddRequest setUseMobilityCallingLineID(Boolean useMobilityCallingLineID)

getUseMobilityCallingLineID

public Boolean getUseMobilityCallingLineID()

setEnableDiversionInhibitor

public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedAddRequest setEnableDiversionInhibitor(Boolean enableDiversionInhibitor)

getEnableDiversionInhibitor

public Boolean getEnableDiversionInhibitor()

setRequireAnswerConfirmation

public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedAddRequest setRequireAnswerConfirmation(Boolean requireAnswerConfirmation)

getRequireAnswerConfirmation

public Boolean getRequireAnswerConfirmation()

setBroadworksCallControl

public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedAddRequest setBroadworksCallControl(Boolean broadworksCallControl)

getBroadworksCallControl

public Boolean getBroadworksCallControl()

setUseSettingLevel

public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedAddRequest setUseSettingLevel(BroadWorksMobilityUserSettingLevel useSettingLevel)

getUseSettingLevel

public BroadWorksMobilityUserSettingLevel getUseSettingLevel()

setDenyCallOriginations

public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedAddRequest setDenyCallOriginations(Boolean denyCallOriginations)

getDenyCallOriginations

public Boolean getDenyCallOriginations()

setDenyCallTerminations

public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedAddRequest setDenyCallTerminations(Boolean denyCallTerminations)

getDenyCallTerminations

public Boolean getDenyCallTerminations()

setDevicesToRing

public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedAddRequest setDevicesToRing(BroadWorksMobilityPhoneToRing devicesToRing)

getDevicesToRing

public BroadWorksMobilityPhoneToRing getDevicesToRing()

setIncludeSharedCallAppearance

public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedAddRequest setIncludeSharedCallAppearance(Boolean includeSharedCallAppearance)

getIncludeSharedCallAppearance

public Boolean getIncludeSharedCallAppearance()

setIncludeBroadworksAnywhere

public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedAddRequest setIncludeBroadworksAnywhere(Boolean includeBroadworksAnywhere)

getIncludeBroadworksAnywhere

public Boolean getIncludeBroadworksAnywhere()

setIncludeExecutiveAssistant

public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedAddRequest setIncludeExecutiveAssistant(Boolean includeExecutiveAssistant)

getIncludeExecutiveAssistant

public Boolean getIncludeExecutiveAssistant()

setMobileNumberAlerted

public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedAddRequest setMobileNumberAlerted(String... mobileNumberAlerted)

getMobileNumberAlerted

public String[] getMobileNumberAlerted()

setEnableCallAnchoring

public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedAddRequest setEnableCallAnchoring(Boolean enableCallAnchoring)

getEnableCallAnchoring

public Boolean getEnableCallAnchoring()

setTimeSchedule

public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedAddRequest setTimeSchedule(ScheduleGlobalKey timeSchedule)

getTimeSchedule

public ScheduleGlobalKey getTimeSchedule()

setHolidaySchedule

public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedAddRequest setHolidaySchedule(ScheduleGlobalKey holidaySchedule)

getHolidaySchedule

public ScheduleGlobalKey getHolidaySchedule()

setAccessDeviceEndpoint

public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedAddRequest setAccessDeviceEndpoint(ConsolidatedSharedCallAppearanceAccessDeviceMultipleIdentityEndpointAdd22 accessDeviceEndpoint)

getAccessDeviceEndpoint

public ConsolidatedSharedCallAppearanceAccessDeviceMultipleIdentityEndpointAdd22 getAccessDeviceEndpoint()

setOutboundAlternateNumber

public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedAddRequest setOutboundAlternateNumber(String outboundAlternateNumber)

getOutboundAlternateNumber

public String getOutboundAlternateNumber()

setEnableDirectRouting

public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedAddRequest setEnableDirectRouting(Boolean enableDirectRouting)

getEnableDirectRouting

public Boolean getEnableDirectRouting()

setMarkCDRAsEnterpriseGroupCalls

public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedAddRequest setMarkCDRAsEnterpriseGroupCalls(Boolean markCDRAsEnterpriseGroupCalls)

getMarkCDRAsEnterpriseGroupCalls

public Boolean getMarkCDRAsEnterpriseGroupCalls()

getEmptyObject

public static UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedAddRequest 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>