Package co.ecg.alpaca.toolkit.generated
Class User.UserConsolidatedModifyRequest
java.lang.Object
co.ecg.alpaca.toolkit.messaging.request.Request<DefaultResponse>
co.ecg.alpaca.toolkit.generated.User.UserConsolidatedModifyRequest
- Enclosing class:
- User
Request to modify a user. If deleteExistingDevices is set to true, when the devices for the main endpoint or SCA service are changed, devices with no more endpoint will be deleted if the command is executed with the correct privilege. Group administrator or above running this command can delete any group level devices. Service provider administrator or above can delete any service provider and group devices. Provisioning administrator or above can delete any devices. An ErrorResponse will be returned if any device cannot be deleted because of insufficient privilege. When phone numbers are un-assigned from the user, the unused numbers may be un-assigned from the group and service provider. If UnassignPhoneNumbersLevel is set to 'Group', the user's primary phone number, fax number and any alternate numbers, will be un-assigned from the group if the command is executed by a service provider administrator or above. When set to 'Service Provider', they will be un-assigned from the group and service provider if the command is executed by a provisioning administrator or above. When omitted, the number(s) will be left assigned to the group. An ErrorResponse will be returned if any number cannot be unassigned because of insufficient privilege. If the phoneNumber has not been assigned to the group and addPhoneNumberToGroup is set to true, it will be added to group if needed if the command is executed by a service provider administrator and above. The command will fail otherwise. Alternate user ids can be added by a group level administrator or above. The password is not required if external authentication is enabled. When sharedCallAppearanceAccessDeviceEndpoint element is included and the Shared Call Appearance service is not assigned after this request, the request will fail. The userService/servicePackwill be authorized to the group if it has not been authorized to the group and the command is excuted by a service provider administrator. The request will fail otherwise. If not present, the authorizedQuantity will be set to unlimited if allowed. If any of the third party voice mail elements are included but the service is not assigned after this request, the request will fail. If the sip authentication elements are included but the SPI Authentication service is not assigned after this request, the request will fail. If the impPassword element is included but the Integrated IMP service is not assigned after this request, the request will fail. The following elements are ignored in XS data mode: nameDialingName alternateUserIdList passcode trunkAddressing thirdPartyVoiceMailServerSelection thirdPartyVoiceMailServerUserServer thirdPartyVoiceMailServerMailboxIdType thirdPartyVoiceMailMailboxURL sipAuthenticationData newUserExternalId emergencyCallbackNumber The response is either SuccessResponse or ErrorResponse.
- 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 @AssertTrue Booleanprotected @Valid StreetAddressprotected Optional<@Valid ReplacementAlternateUserIdEntryList>protected @Size(min=1,max=30) Stringprotected @Size(min=1,max=30) Stringprotected @AssertTrue BooleanOptional<@Valid DepartmentKey>protected Class<? extends DepartmentKey>protected @Size(min=1,max=30) Stringprotected @Size(min=1,max=30) Stringprotected @Size(min=1,max=30) Stringprotected @Size(min=1,max=40) Stringprotected @Size(min=1,max=30) Stringprotected Optional<@Valid NameDialingName>protected @Size(min=1,max=40) Stringprotected @Size(min=1,max=30) Stringprotected @Size(min=1,max=60) Stringprotected @Size(max=36) Stringprotected @Size(min=1,max=161) Stringprotected @Size(min=1,max=30) Stringprotected @Size(min=1,max=60) Stringprotected @Size(min=1,max=60) Stringprotected Optional<@Valid ReplacementConsolidatedServicePackAssignmentList>protected Optional<@Valid ReplacementConsolidatedSharedCallAppearanceAccessDeviceMultipleIdentityEndpointList22>protected Optional<@Valid ReplacementSIPAliasList>protected @Size(min=1,max=80) Stringprotected ThirdPartyVoiceMailSupportMailboxIdTypeprotected @Size(min=1,max=127) Stringprotected UnassignPhoneNumbersLevelprotected @NotNull @Valid BroadWorksUserprotected Optional<@Valid ReplacementConsolidatedUserServiceAssignmentList> -
Constructor Summary
ConstructorsConstructorDescription -
Method Summary
Modifier and TypeMethodDescriptionbooleanbooleanvoidForms the XML Document for this Request Object.Optional<@Valid DepartmentKey>getEmptyObject(BroadWorksServer broadWorksServer) Retrieves this object with minimal setup.Optional<@Valid NameDialingName>Optional<@Valid ReplacementConsolidatedSharedCallAppearanceAccessDeviceMultipleIdentityEndpointList22>Optional<@Valid ReplacementSIPAliasList>getTitle()setAddress(StreetAddress address) setAddressLocation(String addressLocation) setAlternateUserIdList(ReplacementAlternateUserIdEntryList alternateUserIdList) setCallingLineIdFirstName(String callingLineIdFirstName) setCallingLineIdLastName(String callingLineIdLastName) setCallingLineIdPhoneNumber(String callingLineIdPhoneNumber) setDepartment(DepartmentKey department) setDepartment(DepartmentKey department, Class<? extends DepartmentKey> departmentType) setEmailAddress(String emailAddress) setEmergencyCallbackNumber(String emergencyCallbackNumber) setEndpoint(Endpoint endpoint) setExtension(String extension) setFirstName(String firstName) setHiraganaFirstName(String hiraganaFirstName) setHiraganaLastName(String hiraganaLastName) setImpPassword(String impPassword) setLanguage(String language) setLastName(String lastName) setMobilePhoneNumber(String mobilePhoneNumber) setNameDialingName(NameDialingName nameDialingName) setNetworkClassOfService(String networkClassOfService) setNewPasscode(String newPasscode) setNewPassword(String newPassword) setNewSipAuthenticationPassword(String newSipAuthenticationPassword) setNewUserExternalId(String newUserExternalId) setNewUserId(String newUserId) setOldPasscode(String oldPasscode) setOldPassword(String oldPassword) setOldSipAuthenticationPassword(String oldSipAuthenticationPassword) setPagerPhoneNumber(String pagerPhoneNumber) setPhoneNumber(String phoneNumber) setServicePackList(ReplacementConsolidatedServicePackAssignmentList servicePackList) setSharedCallAppearanceAccessDeviceEndpointList(ReplacementConsolidatedSharedCallAppearanceAccessDeviceMultipleIdentityEndpointList22 sharedCallAppearanceAccessDeviceEndpointList) setSipAliasList(ReplacementSIPAliasList sipAliasList) setSipAuthenticationUserName(String sipAuthenticationUserName) setThirdPartyVoiceMailMailboxURL(String thirdPartyVoiceMailMailboxURL) setThirdPartyVoiceMailServerMailboxIdType(ThirdPartyVoiceMailSupportMailboxIdType thirdPartyVoiceMailServerMailboxIdType) setThirdPartyVoiceMailServerSelection(ThirdPartyVoiceMailSupportServerSelection thirdPartyVoiceMailServerSelection) setThirdPartyVoiceMailServerUserServer(String thirdPartyVoiceMailServerUserServer) setTimeZone(String timeZone) setUnassignPhoneNumbers(UnassignPhoneNumbersLevel unassignPhoneNumbers) setUser(BroadWorksUser user) setUserServiceList(ReplacementConsolidatedUserServiceAssignmentList userServiceList) setYahooId(String yahooId) 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
-
deleteExistingDevices
-
unassignPhoneNumbers
-
addPhoneNumberToGroup
-
newUserId
-
lastName
-
firstName
-
callingLineIdLastName
-
callingLineIdFirstName
-
nameDialingName
-
hiraganaLastName
-
hiraganaFirstName
-
phoneNumber
-
alternateUserIdList
-
extension
-
callingLineIdPhoneNumber
-
emergencyCallbackNumber
-
oldPassword
-
newPassword
-
department
-
departmentType
-
language
-
timeZone
-
sipAliasList
-
endpoint
-
title
-
pagerPhoneNumber
-
mobilePhoneNumber
-
emailAddress
-
yahooId
-
addressLocation
-
address
-
networkClassOfService
-
userServiceList
-
servicePackList
-
thirdPartyVoiceMailServerSelection
-
thirdPartyVoiceMailServerUserServer
-
thirdPartyVoiceMailServerMailboxIdType
-
thirdPartyVoiceMailMailboxURL
-
sipAuthenticationUserName
-
newSipAuthenticationPassword
-
oldSipAuthenticationPassword
-
newPasscode
-
oldPasscode
-
impPassword
-
newUserExternalId
-
-
Constructor Details
-
UserConsolidatedModifyRequest
public UserConsolidatedModifyRequest() -
UserConsolidatedModifyRequest
-
-
Method Details
-
setUser
-
getBroadWorksUser
-
setFlagDeleteExistingDevices
-
deleteExistingDevicesFlagExist
public boolean deleteExistingDevicesFlagExist() -
getDeleteExistingDevices
-
setUnassignPhoneNumbers
public User.UserConsolidatedModifyRequest setUnassignPhoneNumbers(UnassignPhoneNumbersLevel unassignPhoneNumbers) -
getUnassignPhoneNumbers
-
setFlagAddPhoneNumberToGroup
-
addPhoneNumberToGroupFlagExist
public boolean addPhoneNumberToGroupFlagExist() -
getAddPhoneNumberToGroup
-
setNewUserId
-
getNewUserId
-
setLastName
-
getLastName
-
setFirstName
-
getFirstName
-
setCallingLineIdLastName
-
getCallingLineIdLastName
-
setCallingLineIdFirstName
-
getCallingLineIdFirstName
-
unsetNameDialingName
-
setNameDialingName
-
getNameDialingName
-
setHiraganaLastName
-
getHiraganaLastName
-
setHiraganaFirstName
-
getHiraganaFirstName
-
unsetPhoneNumber
-
setPhoneNumber
-
getPhoneNumber
-
unsetAlternateUserIdList
-
setAlternateUserIdList
public User.UserConsolidatedModifyRequest setAlternateUserIdList(ReplacementAlternateUserIdEntryList alternateUserIdList) -
getAlternateUserIdList
-
unsetExtension
-
setExtension
-
getExtension
-
unsetCallingLineIdPhoneNumber
-
setCallingLineIdPhoneNumber
public User.UserConsolidatedModifyRequest setCallingLineIdPhoneNumber(String callingLineIdPhoneNumber) -
getCallingLineIdPhoneNumber
-
unsetEmergencyCallbackNumber
-
setEmergencyCallbackNumber
public User.UserConsolidatedModifyRequest setEmergencyCallbackNumber(String emergencyCallbackNumber) -
getEmergencyCallbackNumber
-
setOldPassword
-
getOldPassword
-
unsetNewPassword
-
setNewPassword
-
getNewPassword
-
unsetDepartment
-
setDepartment
public User.UserConsolidatedModifyRequest setDepartment(DepartmentKey department, Class<? extends DepartmentKey> departmentType) -
setDepartment
-
getDepartment
-
setLanguage
-
getLanguage
-
setTimeZone
-
getTimeZone
-
unsetSipAliasList
-
setSipAliasList
-
getSipAliasList
-
unsetEndpoint
-
setEndpoint
-
getEndpoint
-
unsetTitle
-
setTitle
-
getTitle
-
unsetPagerPhoneNumber
-
setPagerPhoneNumber
-
getPagerPhoneNumber
-
unsetMobilePhoneNumber
-
setMobilePhoneNumber
-
getMobilePhoneNumber
-
unsetEmailAddress
-
setEmailAddress
-
getEmailAddress
-
unsetYahooId
-
setYahooId
-
getYahooId
-
unsetAddressLocation
-
setAddressLocation
-
getAddressLocation
-
setAddress
-
getAddress
-
setNetworkClassOfService
-
getNetworkClassOfService
-
unsetUserServiceList
-
setUserServiceList
public User.UserConsolidatedModifyRequest setUserServiceList(ReplacementConsolidatedUserServiceAssignmentList userServiceList) -
getUserServiceList
-
unsetServicePackList
-
setServicePackList
public User.UserConsolidatedModifyRequest setServicePackList(ReplacementConsolidatedServicePackAssignmentList servicePackList) -
getServicePackList
-
setThirdPartyVoiceMailServerSelection
public User.UserConsolidatedModifyRequest setThirdPartyVoiceMailServerSelection(ThirdPartyVoiceMailSupportServerSelection thirdPartyVoiceMailServerSelection) -
getThirdPartyVoiceMailServerSelection
-
unsetThirdPartyVoiceMailServerUserServer
-
setThirdPartyVoiceMailServerUserServer
public User.UserConsolidatedModifyRequest setThirdPartyVoiceMailServerUserServer(String thirdPartyVoiceMailServerUserServer) -
getThirdPartyVoiceMailServerUserServer
-
setThirdPartyVoiceMailServerMailboxIdType
public User.UserConsolidatedModifyRequest setThirdPartyVoiceMailServerMailboxIdType(ThirdPartyVoiceMailSupportMailboxIdType thirdPartyVoiceMailServerMailboxIdType) -
getThirdPartyVoiceMailServerMailboxIdType
-
unsetThirdPartyVoiceMailMailboxURL
-
setThirdPartyVoiceMailMailboxURL
public User.UserConsolidatedModifyRequest setThirdPartyVoiceMailMailboxURL(String thirdPartyVoiceMailMailboxURL) -
getThirdPartyVoiceMailMailboxURL
-
setSipAuthenticationUserName
public User.UserConsolidatedModifyRequest setSipAuthenticationUserName(String sipAuthenticationUserName) -
getSipAuthenticationUserName
-
setNewSipAuthenticationPassword
public User.UserConsolidatedModifyRequest setNewSipAuthenticationPassword(String newSipAuthenticationPassword) -
getNewSipAuthenticationPassword
-
setOldSipAuthenticationPassword
public User.UserConsolidatedModifyRequest setOldSipAuthenticationPassword(String oldSipAuthenticationPassword) -
getOldSipAuthenticationPassword
-
setNewPasscode
-
getNewPasscode
-
setOldPasscode
-
getOldPasscode
-
unsetImpPassword
-
setImpPassword
-
getImpPassword
-
setNewUserExternalId
-
getNewUserExternalId
-
getEmptyObject
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:
formRequestin classRequest<DefaultResponse>
-