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

Class UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityAddRequest

java.lang.Object

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

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

Enclosing class:

UserBroadWorksMobility

@Choice(minOccurs=0,value={@ChoiceGroup("accessDeviceEndpoint"),@ChoiceGroup("outboundAlternateNumber")})
public static class UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityAddRequest
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 AccessDeviceEndpointAdd	accessDeviceEndpoint
protected @NotNull java.lang.Boolean	alertAgentCalls
protected @NotNull java.lang.Boolean	alertClickToDialCalls
protected @NotNull java.lang.Boolean	alertGroupPagingCalls
protected @NotNull java.lang.Boolean	broadworksCallControl
protected @NotNull java.lang.Boolean	denyCallOriginations
protected @NotNull java.lang.Boolean	denyCallTerminations
protected @Size(min=1,max=40) java.lang.String	description
protected @NotNull BroadWorksMobilityPhoneToRing	devicesToRing
protected @NotNull java.lang.Boolean	enableAlerting
protected @NotNull java.lang.Boolean	enableCallAnchoring
protected @NotNull java.lang.Boolean	enableDirectRouting
protected @NotNull java.lang.Boolean	enableDiversionInhibitor
protected @Valid ScheduleGlobalKey	holidaySchedule
protected @NotNull java.lang.Boolean	includeBroadworksAnywhere
protected @NotNull java.lang.Boolean	includeExecutiveAssistant
protected @NotNull java.lang.Boolean	includeSharedCallAppearance
protected @NotNull java.lang.Boolean	isPrimary
protected @NotNull java.lang.Boolean	markCDRAsEnterpriseGroupCalls
protected @NotNull @Size(min=1,max=23) java.lang.String	mobileNumber
protected java.lang.String[]	mobileNumberAlerted
protected @Size(min=1,max=161) java.lang.String	outboundAlternateNumber
protected @NotNull java.lang.Boolean	requireAnswerConfirmation
protected @Valid ScheduleGlobalKey	timeSchedule
protected @NotNull java.lang.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
UserBroadWorksMobilityMobileIdentityAddRequest()
UserBroadWorksMobilityMobileIdentityAddRequest(BroadWorksUser user, java.lang.String mobileNumber, java.lang.Boolean isPrimary, java.lang.Boolean enableAlerting, java.lang.Boolean alertAgentCalls, java.lang.Boolean alertClickToDialCalls, java.lang.Boolean alertGroupPagingCalls, java.lang.Boolean useMobilityCallingLineID, java.lang.Boolean enableDiversionInhibitor, java.lang.Boolean requireAnswerConfirmation, java.lang.Boolean broadworksCallControl, BroadWorksMobilityUserSettingLevel useSettingLevel, java.lang.Boolean denyCallOriginations, java.lang.Boolean denyCallTerminations, BroadWorksMobilityPhoneToRing devicesToRing, java.lang.Boolean includeSharedCallAppearance, java.lang.Boolean includeBroadworksAnywhere, java.lang.Boolean includeExecutiveAssistant, java.lang.Boolean enableCallAnchoring, java.lang.Boolean enableDirectRouting, java.lang.Boolean markCDRAsEnterpriseGroupCalls)

Method Summary

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

description

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

isPrimary

@NotNull protected @NotNull java.lang.Boolean isPrimary

enableAlerting

@NotNull protected @NotNull java.lang.Boolean enableAlerting

alertAgentCalls

@NotNull protected @NotNull java.lang.Boolean alertAgentCalls

alertClickToDialCalls

@NotNull protected @NotNull java.lang.Boolean alertClickToDialCalls

alertGroupPagingCalls

@NotNull protected @NotNull java.lang.Boolean alertGroupPagingCalls

useMobilityCallingLineID

@NotNull protected @NotNull java.lang.Boolean useMobilityCallingLineID

enableDiversionInhibitor

@NotNull protected @NotNull java.lang.Boolean enableDiversionInhibitor

requireAnswerConfirmation

@NotNull protected @NotNull java.lang.Boolean requireAnswerConfirmation

broadworksCallControl

@NotNull protected @NotNull java.lang.Boolean broadworksCallControl

useSettingLevel

@NotNull protected @NotNull BroadWorksMobilityUserSettingLevel useSettingLevel

denyCallOriginations

@NotNull protected @NotNull java.lang.Boolean denyCallOriginations

denyCallTerminations

@NotNull protected @NotNull java.lang.Boolean denyCallTerminations

devicesToRing

@NotNull protected @NotNull BroadWorksMobilityPhoneToRing devicesToRing

includeSharedCallAppearance

@NotNull protected @NotNull java.lang.Boolean includeSharedCallAppearance

includeBroadworksAnywhere

@NotNull protected @NotNull java.lang.Boolean includeBroadworksAnywhere

includeExecutiveAssistant

@NotNull protected @NotNull java.lang.Boolean includeExecutiveAssistant

mobileNumberAlerted

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

enableCallAnchoring

@NotNull protected @NotNull java.lang.Boolean enableCallAnchoring

timeSchedule

@Valid protected @Valid ScheduleGlobalKey timeSchedule

holidaySchedule

@Valid protected @Valid ScheduleGlobalKey holidaySchedule

accessDeviceEndpoint

@Valid protected @Valid AccessDeviceEndpointAdd accessDeviceEndpoint

outboundAlternateNumber

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

enableDirectRouting

@NotNull protected @NotNull java.lang.Boolean enableDirectRouting

markCDRAsEnterpriseGroupCalls

@NotNull protected @NotNull java.lang.Boolean markCDRAsEnterpriseGroupCalls

Constructor Details

UserBroadWorksMobilityMobileIdentityAddRequest

public UserBroadWorksMobilityMobileIdentityAddRequest()

UserBroadWorksMobilityMobileIdentityAddRequest

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

Method Details

setUser

public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityAddRequest setUser(BroadWorksUser user)

getBroadWorksUser

public BroadWorksUser getBroadWorksUser()

setMobileNumber

public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityAddRequest setMobileNumber(java.lang.String mobileNumber)

getMobileNumber

public java.lang.String getMobileNumber()

setDescription

public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityAddRequest setDescription(java.lang.String description)

getDescription

public java.lang.String getDescription()

setIsPrimary

public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityAddRequest setIsPrimary(java.lang.Boolean isPrimary)

getIsPrimary

public java.lang.Boolean getIsPrimary()

setEnableAlerting

public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityAddRequest setEnableAlerting(java.lang.Boolean enableAlerting)

getEnableAlerting

public java.lang.Boolean getEnableAlerting()

setAlertAgentCalls

public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityAddRequest setAlertAgentCalls(java.lang.Boolean alertAgentCalls)

getAlertAgentCalls

public java.lang.Boolean getAlertAgentCalls()

setAlertClickToDialCalls

public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityAddRequest setAlertClickToDialCalls(java.lang.Boolean alertClickToDialCalls)

getAlertClickToDialCalls

public java.lang.Boolean getAlertClickToDialCalls()

setAlertGroupPagingCalls

public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityAddRequest setAlertGroupPagingCalls(java.lang.Boolean alertGroupPagingCalls)

getAlertGroupPagingCalls

public java.lang.Boolean getAlertGroupPagingCalls()

setUseMobilityCallingLineID

public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityAddRequest setUseMobilityCallingLineID(java.lang.Boolean useMobilityCallingLineID)

getUseMobilityCallingLineID

public java.lang.Boolean getUseMobilityCallingLineID()

setEnableDiversionInhibitor

public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityAddRequest setEnableDiversionInhibitor(java.lang.Boolean enableDiversionInhibitor)

getEnableDiversionInhibitor

public java.lang.Boolean getEnableDiversionInhibitor()

setRequireAnswerConfirmation

public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityAddRequest setRequireAnswerConfirmation(java.lang.Boolean requireAnswerConfirmation)

getRequireAnswerConfirmation

public java.lang.Boolean getRequireAnswerConfirmation()

setBroadworksCallControl

public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityAddRequest setBroadworksCallControl(java.lang.Boolean broadworksCallControl)

getBroadworksCallControl

public java.lang.Boolean getBroadworksCallControl()

setUseSettingLevel

public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityAddRequest setUseSettingLevel(BroadWorksMobilityUserSettingLevel useSettingLevel)

getUseSettingLevel

public BroadWorksMobilityUserSettingLevel getUseSettingLevel()

setDenyCallOriginations

public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityAddRequest setDenyCallOriginations(java.lang.Boolean denyCallOriginations)

getDenyCallOriginations

public java.lang.Boolean getDenyCallOriginations()

setDenyCallTerminations

public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityAddRequest setDenyCallTerminations(java.lang.Boolean denyCallTerminations)

getDenyCallTerminations

public java.lang.Boolean getDenyCallTerminations()

setDevicesToRing

public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityAddRequest setDevicesToRing(BroadWorksMobilityPhoneToRing devicesToRing)

getDevicesToRing

public BroadWorksMobilityPhoneToRing getDevicesToRing()

setIncludeSharedCallAppearance

public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityAddRequest setIncludeSharedCallAppearance(java.lang.Boolean includeSharedCallAppearance)

getIncludeSharedCallAppearance

public java.lang.Boolean getIncludeSharedCallAppearance()

setIncludeBroadworksAnywhere

public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityAddRequest setIncludeBroadworksAnywhere(java.lang.Boolean includeBroadworksAnywhere)

getIncludeBroadworksAnywhere

public java.lang.Boolean getIncludeBroadworksAnywhere()

setIncludeExecutiveAssistant

public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityAddRequest setIncludeExecutiveAssistant(java.lang.Boolean includeExecutiveAssistant)

getIncludeExecutiveAssistant

public java.lang.Boolean getIncludeExecutiveAssistant()

setMobileNumberAlerted

public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityAddRequest setMobileNumberAlerted(java.lang.String... mobileNumberAlerted)

getMobileNumberAlerted

public java.lang.String[] getMobileNumberAlerted()

setEnableCallAnchoring

public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityAddRequest setEnableCallAnchoring(java.lang.Boolean enableCallAnchoring)

getEnableCallAnchoring

public java.lang.Boolean getEnableCallAnchoring()

setTimeSchedule

public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityAddRequest setTimeSchedule(ScheduleGlobalKey timeSchedule)

getTimeSchedule

public ScheduleGlobalKey getTimeSchedule()

setHolidaySchedule

public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityAddRequest setHolidaySchedule(ScheduleGlobalKey holidaySchedule)

getHolidaySchedule

public ScheduleGlobalKey getHolidaySchedule()

setAccessDeviceEndpoint

public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityAddRequest setAccessDeviceEndpoint(AccessDeviceEndpointAdd accessDeviceEndpoint)

getAccessDeviceEndpoint

public AccessDeviceEndpointAdd getAccessDeviceEndpoint()

setOutboundAlternateNumber

public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityAddRequest setOutboundAlternateNumber(java.lang.String outboundAlternateNumber)

getOutboundAlternateNumber

public java.lang.String getOutboundAlternateNumber()

setEnableDirectRouting

public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityAddRequest setEnableDirectRouting(java.lang.Boolean enableDirectRouting)

getEnableDirectRouting

public java.lang.Boolean getEnableDirectRouting()

setMarkCDRAsEnterpriseGroupCalls

public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityAddRequest setMarkCDRAsEnterpriseGroupCalls(java.lang.Boolean markCDRAsEnterpriseGroupCalls)

getMarkCDRAsEnterpriseGroupCalls

public java.lang.Boolean getMarkCDRAsEnterpriseGroupCalls()

getEmptyObject

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