Package co.ecg.alpaca.toolkit.generated
Class User.UserConsolidatedDeleteRequest
java.lang.Object
co.ecg.alpaca.toolkit.messaging.request.Request<DefaultResponse>
co.ecg.alpaca.toolkit.generated.User.UserConsolidatedDeleteRequest
- Enclosing class:
- User
public static class User.UserConsolidatedDeleteRequest extends Request<DefaultResponse>
Request to delete a user. If deleteExistingDevices is set to true, after the user is deleted, any device that is only used by the deleted user prior to the deletion will be deleted if the command is executed with the correct priviledge. 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. 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.
- 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 @AssertTrue Boolean
deleteExistingDevices
protected UnassignPhoneNumbersLevel
unassignPhoneNumbers
protected @NotNull @Valid BroadWorksUser
user
-
Constructor Summary
Constructors Constructor Description UserConsolidatedDeleteRequest()
UserConsolidatedDeleteRequest(BroadWorksUser user)
-
Method Summary
Modifier and Type Method Description boolean
deleteExistingDevicesFlagExist()
void
formRequest()
Forms the XML Document for this Request Object.BroadWorksUser
getBroadWorksUser()
Boolean
getDeleteExistingDevices()
static User.UserConsolidatedDeleteRequest
getEmptyObject(BroadWorksServer broadWorksServer)
Retrieves this object with minimal setup.UnassignPhoneNumbersLevel
getUnassignPhoneNumbers()
User.UserConsolidatedDeleteRequest
setFlagDeleteExistingDevices()
User.UserConsolidatedDeleteRequest
setUnassignPhoneNumbers(UnassignPhoneNumbersLevel unassignPhoneNumbers)
User.UserConsolidatedDeleteRequest
setUser(BroadWorksUser user)
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
-
Field Details
-
Constructor Details
-
UserConsolidatedDeleteRequest
public UserConsolidatedDeleteRequest() -
UserConsolidatedDeleteRequest
-
-
Method Details
-
setUser
-
getBroadWorksUser
-
setFlagDeleteExistingDevices
-
deleteExistingDevicesFlagExist
public boolean deleteExistingDevicesFlagExist() -
getDeleteExistingDevices
-
setUnassignPhoneNumbers
public User.UserConsolidatedDeleteRequest setUnassignPhoneNumbers(UnassignPhoneNumbersLevel unassignPhoneNumbers) -
getUnassignPhoneNumbers
-
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:
formRequest
in classRequest<DefaultResponse>
-