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

Class UserBroadWorksMobility.UserBroadWorksMobilityModifyRequest

java.lang.Object

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

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

Enclosing class:

UserBroadWorksMobility

public static class UserBroadWorksMobility.UserBroadWorksMobilityModifyRequest
extends Request<DefaultResponse>

Modify the user's BroadWorks Mobility service settings. The response is either a SuccessResponse or an ErrorResponse. The isActive, useMobileIdentityCallAnchoring, and preventCallsToOwnMobiles parameters can be modified by users with Group Authorization Level and above. The mobileIdentity, profileIdentityDevicesToRing, rofileIdentityIncludeSharedCallAppearance, profileIdentityIncludeBroadworksAnywhere mobileIdentity and profileIdentityMobilityNumbersAlerted parameters can be modified by users with User Authorization Level and above when the BroadWorks Mobility service is turned on.

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 Boolean	isActive
protected @Valid @Size(max=10) BroadWorksMobilityUserMobileIdentityModifyEntry[]	mobileIdentity
protected Boolean	preventCallsToOwnMobiles
protected BroadWorksMobilityPhoneToRing	profileIdentityDevicesToRing
protected Boolean	profileIdentityIncludeBroadworksAnywhere
protected Boolean	profileIdentityIncludeExecutiveAssistant
protected Boolean	profileIdentityIncludeSharedCallAppearance
protected Optional<@Valid BroadWorksMobilityAlertingMobileNumberReplacementList>	profileIdentityMobilityNumbersAlerted
protected Boolean	useMobileIdentityCallAnchoring
protected @NotNull @Valid BroadWorksUser	user

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

log

Constructor Summary

Constructors

Constructor	Description
UserBroadWorksMobilityModifyRequest()
UserBroadWorksMobilityModifyRequest(BroadWorksUser user)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
BroadWorksUser	getBroadWorksUser()
static UserBroadWorksMobility.UserBroadWorksMobilityModifyRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
Boolean	getIsActive()
BroadWorksMobilityUserMobileIdentityModifyEntry[]	getMobileIdentity()
Boolean	getPreventCallsToOwnMobiles()
BroadWorksMobilityPhoneToRing	getProfileIdentityDevicesToRing()
Boolean	getProfileIdentityIncludeBroadworksAnywhere()
Boolean	getProfileIdentityIncludeExecutiveAssistant()
Boolean	getProfileIdentityIncludeSharedCallAppearance()
Optional<@Valid BroadWorksMobilityAlertingMobileNumberReplacementList>	getProfileIdentityMobilityNumbersAlerted()
Boolean	getUseMobileIdentityCallAnchoring()
UserBroadWorksMobility.UserBroadWorksMobilityModifyRequest	setIsActive(Boolean isActive)
UserBroadWorksMobility.UserBroadWorksMobilityModifyRequest	setMobileIdentity(BroadWorksMobilityUserMobileIdentityModifyEntry... mobileIdentity)
UserBroadWorksMobility.UserBroadWorksMobilityModifyRequest	setPreventCallsToOwnMobiles(Boolean preventCallsToOwnMobiles)
UserBroadWorksMobility.UserBroadWorksMobilityModifyRequest	setProfileIdentityDevicesToRing(BroadWorksMobilityPhoneToRing profileIdentityDevicesToRing)
UserBroadWorksMobility.UserBroadWorksMobilityModifyRequest	setProfileIdentityIncludeBroadworksAnywhere(Boolean profileIdentityIncludeBroadworksAnywhere)
UserBroadWorksMobility.UserBroadWorksMobilityModifyRequest	setProfileIdentityIncludeExecutiveAssistant(Boolean profileIdentityIncludeExecutiveAssistant)
UserBroadWorksMobility.UserBroadWorksMobilityModifyRequest	setProfileIdentityIncludeSharedCallAppearance(Boolean profileIdentityIncludeSharedCallAppearance)
UserBroadWorksMobility.UserBroadWorksMobilityModifyRequest	setProfileIdentityMobilityNumbersAlerted(BroadWorksMobilityAlertingMobileNumberReplacementList profileIdentityMobilityNumbersAlerted)
UserBroadWorksMobility.UserBroadWorksMobilityModifyRequest	setUseMobileIdentityCallAnchoring(Boolean useMobileIdentityCallAnchoring)
UserBroadWorksMobility.UserBroadWorksMobilityModifyRequest	setUser(BroadWorksUser user)
UserBroadWorksMobility.UserBroadWorksMobilityModifyRequest	unsetProfileIdentityMobilityNumbersAlerted()

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

isActive

protected Boolean isActive

useMobileIdentityCallAnchoring

protected Boolean useMobileIdentityCallAnchoring

preventCallsToOwnMobiles

protected Boolean preventCallsToOwnMobiles

mobileIdentity

@Valid
@Size(max=10)
protected @Valid @Size(max=10) BroadWorksMobilityUserMobileIdentityModifyEntry[] mobileIdentity

profileIdentityDevicesToRing

protected BroadWorksMobilityPhoneToRing profileIdentityDevicesToRing

profileIdentityIncludeSharedCallAppearance

protected Boolean profileIdentityIncludeSharedCallAppearance

profileIdentityIncludeBroadworksAnywhere

protected Boolean profileIdentityIncludeBroadworksAnywhere

profileIdentityIncludeExecutiveAssistant

protected Boolean profileIdentityIncludeExecutiveAssistant

profileIdentityMobilityNumbersAlerted

protected Optional<@Valid BroadWorksMobilityAlertingMobileNumberReplacementList> profileIdentityMobilityNumbersAlerted

Constructor Details

UserBroadWorksMobilityModifyRequest

public UserBroadWorksMobilityModifyRequest()

UserBroadWorksMobilityModifyRequest

public UserBroadWorksMobilityModifyRequest(BroadWorksUser user)

Method Details

setUser

public UserBroadWorksMobility.UserBroadWorksMobilityModifyRequest setUser(BroadWorksUser user)

getBroadWorksUser

public BroadWorksUser getBroadWorksUser()

setIsActive

public UserBroadWorksMobility.UserBroadWorksMobilityModifyRequest setIsActive(Boolean isActive)

getIsActive

public Boolean getIsActive()

setUseMobileIdentityCallAnchoring

public UserBroadWorksMobility.UserBroadWorksMobilityModifyRequest setUseMobileIdentityCallAnchoring(Boolean useMobileIdentityCallAnchoring)

getUseMobileIdentityCallAnchoring

public Boolean getUseMobileIdentityCallAnchoring()

setPreventCallsToOwnMobiles

public UserBroadWorksMobility.UserBroadWorksMobilityModifyRequest setPreventCallsToOwnMobiles(Boolean preventCallsToOwnMobiles)

getPreventCallsToOwnMobiles

public Boolean getPreventCallsToOwnMobiles()

setMobileIdentity

public UserBroadWorksMobility.UserBroadWorksMobilityModifyRequest setMobileIdentity(BroadWorksMobilityUserMobileIdentityModifyEntry... mobileIdentity)

getMobileIdentity

public BroadWorksMobilityUserMobileIdentityModifyEntry[] getMobileIdentity()

setProfileIdentityDevicesToRing

public UserBroadWorksMobility.UserBroadWorksMobilityModifyRequest setProfileIdentityDevicesToRing(BroadWorksMobilityPhoneToRing profileIdentityDevicesToRing)

getProfileIdentityDevicesToRing

public BroadWorksMobilityPhoneToRing getProfileIdentityDevicesToRing()

setProfileIdentityIncludeSharedCallAppearance

public UserBroadWorksMobility.UserBroadWorksMobilityModifyRequest setProfileIdentityIncludeSharedCallAppearance(Boolean profileIdentityIncludeSharedCallAppearance)

getProfileIdentityIncludeSharedCallAppearance

public Boolean getProfileIdentityIncludeSharedCallAppearance()

setProfileIdentityIncludeBroadworksAnywhere

public UserBroadWorksMobility.UserBroadWorksMobilityModifyRequest setProfileIdentityIncludeBroadworksAnywhere(Boolean profileIdentityIncludeBroadworksAnywhere)

getProfileIdentityIncludeBroadworksAnywhere

public Boolean getProfileIdentityIncludeBroadworksAnywhere()

setProfileIdentityIncludeExecutiveAssistant

public UserBroadWorksMobility.UserBroadWorksMobilityModifyRequest setProfileIdentityIncludeExecutiveAssistant(Boolean profileIdentityIncludeExecutiveAssistant)

getProfileIdentityIncludeExecutiveAssistant

public Boolean getProfileIdentityIncludeExecutiveAssistant()

unsetProfileIdentityMobilityNumbersAlerted

public UserBroadWorksMobility.UserBroadWorksMobilityModifyRequest unsetProfileIdentityMobilityNumbersAlerted()

setProfileIdentityMobilityNumbersAlerted

public UserBroadWorksMobility.UserBroadWorksMobilityModifyRequest setProfileIdentityMobilityNumbersAlerted(BroadWorksMobilityAlertingMobileNumberReplacementList profileIdentityMobilityNumbersAlerted)

getProfileIdentityMobilityNumbersAlerted

public Optional<@Valid BroadWorksMobilityAlertingMobileNumberReplacementList> getProfileIdentityMobilityNumbersAlerted()

getEmptyObject

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