Package co.ecg.alpaca.toolkit.generated
Class User.UserConsolidatedAddRequest
java.lang.Object
co.ecg.alpaca.toolkit.messaging.request.Request<DefaultResponse>
co.ecg.alpaca.toolkit.generated.User.UserConsolidatedAddRequest
- Enclosing class:
User
@ChoiceGroup("groupExternalId") @ChoiceGroup({"serviceProviderId","groupId"}) @Choice(minOccurs=0,value={@ChoiceGroup("accessDeviceEndpoint"),@ChoiceGroup("trunkAddressing")})
public static class User.UserConsolidatedAddRequest
extends Request<DefaultResponse>
The response is either SuccessResponse or ErrorResponse. In AS Data Mode: The group user limit will be increased by one if needed. The group will be added if it does not exist and if the command is executed by a Service Provider level administrator or above. If the group needs to be created, the groupProperties element must be set or the request will fail. The groupProperties element will be ignored if the group already exists. If the domain has not been assigned to the group, it will be added to group if the command is executed by a Service provider level administrator or above. If the domain has not been assigned to the service provider, it will be added to the service provider if the command is executed by a Provisioning level administrator or above. The command will fail otherwise. If the phoneNumber has not been assigned to the group and addPhoneNumberToGroup is set to true, it will be added to group if the command is executed by a service provider administrator or above and the number is already assigned to the service provider. The command will fail otherwise. The password is not required if external authentication is enabled. Alternate user ids can be added by a group level administrator or above. When sharedCallAppearanceAccessDeviceEndpoint element is included and the Shared Call Appearance is not included in the service/service pack of the request or in the "new user template", the request will fail. The userService/servicePack will be authorized to the group if it has not been authorized to the group if the command is executed by a Service Provider level administrator or above. The command will fail otherwise. The authorizedQuantity will be set to unlimited if not present. When thirdPartyVoiceMail elements are included and the Third Party Voice Mail Support service is not included in the service/service pack of the request or in the "new user template", the request will fail. When sipAuthenticationData element is included and the Authentication service is not included in the service/service pack of the request or in the "new user template", the request will fail. In XS data mode: only the System level administrator has the authorization level to execute the command. The group will be added if it does not exist. If the group needs to be created, the groupProperties element must be set or the request will fail. The groupProperties element will be ignored if the group already exists. If the phoneNumber has not been assigned to the group, it will be added to group and service provider if needed. When sharedCallAppearanceAccessDeviceEndpoint element is included and the Shared Call Appearance is not included in the service/service pack of the request, the request will fail. The following elements are ignored in XS data mode: addPhoneNumberToGroup nameDialingName alternateUserId passcode trunkAddressing thirdPartyVoiceMailServerSelection thirdPartyVoiceMailServerUserServer thirdPartyVoiceMailServerMailboxIdType thirdPartyVoiceMailMailboxURL sipAuthenticationData isPlace emergencyCallbackNumber
- 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 @Valid ConsolidatedAccessDeviceMultipleIdentityEndpointAndContactAdd22protected @AssertTrue Booleanprotected @Valid StreetAddressprotected @Size(min=1,max=80) Stringprotected @Size(max=3) String[]protected @Valid @Size(max=4) AlternateUserIdEntry[]protected @NotNull @Size(min=1,max=30) Stringprotected @NotNull @Size(min=1,max=30) Stringprotected @Size(min=1,max=23) Stringprotected @Valid DepartmentKeyprotected @Size(min=1,max=80) Stringprotected @Size(min=1,max=23) Stringprotected @Size(min=2,max=20) Stringprotected @NotNull @Size(min=1,max=30) Stringprotected @Size(max=36) Stringprotected @Size(min=1,max=30) Stringprotected @Valid ConsolidatedGroupPropertiesprotected @Size(min=1,max=30) Stringprotected @Size(min=1,max=30) Stringprotected Booleanprotected @Size(min=1,max=40) Stringprotected @NotNull @Size(min=1,max=30) Stringprotected @Size(min=1,max=30) Stringprotected @Valid NameDialingNameprotected @Size(min=1,max=40) Stringprotected @Size(min=1,max=30) Stringprotected @Size(min=1,max=30) Stringprotected @Size(min=1,max=60) Stringprotected @Size(min=1,max=23) Stringprotected @Valid ConsolidatedServicePackAssignment[]protected @Size(min=1,max=30) Stringprotected @Valid @Size(max=35) ConsolidatedSharedCallAppearanceAccessDeviceMultipleIdentityEndpointAdd22[]protected @Valid SIPAuthenticationUserNamePasswordprotected ThirdPartyVoiceMailSupportMailboxIdTypeprotected @Size(min=1,max=127) Stringprotected @Size(min=1,max=50) Stringprotected @Valid TrunkAddressingMultipleContactAddprotected @Size(max=36) Stringprotected @NotNull @Size(min=1,max=161) Stringprotected @Size(max=82) Stringprotected @Valid ConsolidatedUserServiceAssignment[]protected @Size(min=1,max=50) String -
Constructor Summary
ConstructorsConstructorDescriptionUserConsolidatedAddRequest(BroadWorksServer broadWorksServer, String userId, String lastName, String firstName, String callingLineIdLastName, String callingLineIdFirstName) UserConsolidatedAddRequest(BroadWorksServer broadWorksServer, String groupExternalId, String userId, String lastName, String firstName, String callingLineIdLastName, String callingLineIdFirstName) UserConsolidatedAddRequest(BroadWorksServer broadWorksServer, String serviceProviderId, String groupId, String userId, String lastName, String firstName, String callingLineIdLastName, String callingLineIdFirstName) -
Method Summary
Modifier and TypeMethodDescriptionbooleanvoidForms the XML Document for this Request Object.String[]getAlias()getEmptyObject(BroadWorksServer broadWorksServer) Retrieves this object with minimal setup.getTitle()setAccessDeviceEndpoint(ConsolidatedAccessDeviceMultipleIdentityEndpointAndContactAdd22 accessDeviceEndpoint) setAddress(StreetAddress address) setAddressLocation(String addressLocation) setAlternateUserId(AlternateUserIdEntry... alternateUserId) setCallingLineIdFirstName(String callingLineIdFirstName) setCallingLineIdLastName(String callingLineIdLastName) setCallingLineIdPhoneNumber(String callingLineIdPhoneNumber) setDepartment(DepartmentKey department) setEmailAddress(String emailAddress) setEmergencyCallbackNumber(String emergencyCallbackNumber) setExtension(String extension) setFirstName(String firstName) setGroupExternalId(String groupExternalId) setGroupId(String groupId) setGroupProperties(ConsolidatedGroupProperties groupProperties) setHiraganaFirstName(String hiraganaFirstName) setHiraganaLastName(String hiraganaLastName) setIsPlace(Boolean isPlace) setLanguage(String language) setLastName(String lastName) setMobilePhoneNumber(String mobilePhoneNumber) setNameDialingName(NameDialingName nameDialingName) setNetworkClassOfService(String networkClassOfService) setPagerPhoneNumber(String pagerPhoneNumber) setPasscode(String passcode) setPassword(String password) setPhoneNumber(String phoneNumber) setServicePack(ConsolidatedServicePackAssignment... servicePack) setServiceProviderId(String serviceProviderId) setSharedCallAppearanceAccessDeviceEndpoint(ConsolidatedSharedCallAppearanceAccessDeviceMultipleIdentityEndpointAdd22... sharedCallAppearanceAccessDeviceEndpoint) setSipAuthenticationData(SIPAuthenticationUserNamePassword sipAuthenticationData) setThirdPartyVoiceMailMailboxURL(String thirdPartyVoiceMailMailboxURL) setThirdPartyVoiceMailServerMailboxIdType(ThirdPartyVoiceMailSupportMailboxIdType thirdPartyVoiceMailServerMailboxIdType) setThirdPartyVoiceMailServerSelection(ThirdPartyVoiceMailSupportServerSelection thirdPartyVoiceMailServerSelection) setThirdPartyVoiceMailServerUserServer(String thirdPartyVoiceMailServerUserServer) setTimeZone(String timeZone) setTrunkAddressing(TrunkAddressingMultipleContactAdd trunkAddressing) setUserExternalId(String userExternalId) setUserPersonId(String userPersonId) setUserService(ConsolidatedUserServiceAssignment... userService) 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
-
serviceProviderId
-
groupId
-
groupExternalId
-
groupProperties
-
userId
-
userExternalId
-
userPersonId
-
addPhoneNumberToGroup
-
lastName
-
firstName
-
callingLineIdLastName
-
callingLineIdFirstName
-
nameDialingName
-
hiraganaLastName
-
hiraganaFirstName
-
phoneNumber
-
alternateUserId
-
extension
-
callingLineIdPhoneNumber
-
emergencyCallbackNumber
-
password
-
passcode
-
department
-
language
-
timeZone
-
alias
-
accessDeviceEndpoint
@Valid protected @Valid ConsolidatedAccessDeviceMultipleIdentityEndpointAndContactAdd22 accessDeviceEndpoint -
trunkAddressing
-
title
-
pagerPhoneNumber
-
mobilePhoneNumber
-
emailAddress
-
yahooId
-
addressLocation
-
address
-
networkClassOfService
-
userService
-
servicePack
-
thirdPartyVoiceMailServerSelection
-
thirdPartyVoiceMailServerUserServer
-
thirdPartyVoiceMailServerMailboxIdType
-
thirdPartyVoiceMailMailboxURL
-
sipAuthenticationData
-
isPlace
-
-
Constructor Details
-
UserConsolidatedAddRequest
public UserConsolidatedAddRequest() -
UserConsolidatedAddRequest
-
UserConsolidatedAddRequest
-
UserConsolidatedAddRequest
-
-
Method Details
-
setServiceProviderId
-
getServiceProviderId
-
setGroupId
-
getGroupId
-
setGroupExternalId
-
getGroupExternalId
-
setGroupProperties
public User.UserConsolidatedAddRequest setGroupProperties(ConsolidatedGroupProperties groupProperties) -
getGroupProperties
-
setUserId
-
getUserId
-
setUserExternalId
-
getUserExternalId
-
setUserPersonId
-
getUserPersonId
-
setFlagAddPhoneNumberToGroup
-
addPhoneNumberToGroupFlagExist
public boolean addPhoneNumberToGroupFlagExist() -
getAddPhoneNumberToGroup
-
setLastName
-
getLastName
-
setFirstName
-
getFirstName
-
setCallingLineIdLastName
-
getCallingLineIdLastName
-
setCallingLineIdFirstName
-
getCallingLineIdFirstName
-
setNameDialingName
-
getNameDialingName
-
setHiraganaLastName
-
getHiraganaLastName
-
setHiraganaFirstName
-
getHiraganaFirstName
-
setPhoneNumber
-
getPhoneNumber
-
setAlternateUserId
-
getAlternateUserId
-
setExtension
-
getExtension
-
setCallingLineIdPhoneNumber
-
getCallingLineIdPhoneNumber
-
setEmergencyCallbackNumber
-
getEmergencyCallbackNumber
-
setPassword
-
getPassword
-
setPasscode
-
getPasscode
-
setDepartment
-
getDepartment
-
setLanguage
-
getLanguage
-
setTimeZone
-
getTimeZone
-
setAlias
-
getAlias
-
setAccessDeviceEndpoint
public User.UserConsolidatedAddRequest setAccessDeviceEndpoint(ConsolidatedAccessDeviceMultipleIdentityEndpointAndContactAdd22 accessDeviceEndpoint) -
getAccessDeviceEndpoint
-
setTrunkAddressing
public User.UserConsolidatedAddRequest setTrunkAddressing(TrunkAddressingMultipleContactAdd trunkAddressing) -
getTrunkAddressing
-
setTitle
-
getTitle
-
setPagerPhoneNumber
-
getPagerPhoneNumber
-
setMobilePhoneNumber
-
getMobilePhoneNumber
-
setEmailAddress
-
getEmailAddress
-
setYahooId
-
getYahooId
-
setAddressLocation
-
getAddressLocation
-
setAddress
-
getAddress
-
setNetworkClassOfService
-
getNetworkClassOfService
-
setUserService
public User.UserConsolidatedAddRequest setUserService(ConsolidatedUserServiceAssignment... userService) -
getUserService
-
setServicePack
public User.UserConsolidatedAddRequest setServicePack(ConsolidatedServicePackAssignment... servicePack) -
getServicePack
-
setThirdPartyVoiceMailServerSelection
public User.UserConsolidatedAddRequest setThirdPartyVoiceMailServerSelection(ThirdPartyVoiceMailSupportServerSelection thirdPartyVoiceMailServerSelection) -
getThirdPartyVoiceMailServerSelection
-
unsetThirdPartyVoiceMailServerUserServer
-
setThirdPartyVoiceMailServerUserServer
public User.UserConsolidatedAddRequest setThirdPartyVoiceMailServerUserServer(String thirdPartyVoiceMailServerUserServer) -
getThirdPartyVoiceMailServerUserServer
-
setThirdPartyVoiceMailServerMailboxIdType
public User.UserConsolidatedAddRequest setThirdPartyVoiceMailServerMailboxIdType(ThirdPartyVoiceMailSupportMailboxIdType thirdPartyVoiceMailServerMailboxIdType) -
getThirdPartyVoiceMailServerMailboxIdType
-
unsetThirdPartyVoiceMailMailboxURL
-
setThirdPartyVoiceMailMailboxURL
public User.UserConsolidatedAddRequest setThirdPartyVoiceMailMailboxURL(String thirdPartyVoiceMailMailboxURL) -
getThirdPartyVoiceMailMailboxURL
-
setSipAuthenticationData
public User.UserConsolidatedAddRequest setSipAuthenticationData(SIPAuthenticationUserNamePassword sipAuthenticationData) -
getSipAuthenticationData
-
setIsPlace
-
getIsPlace
-
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>
-