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

Class UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedDeleteRequest

java.lang.Object

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

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

Enclosing class:

UserBroadWorksMobility

public static class UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedDeleteRequest
extends Request<DefaultResponse>

Delete a mobile identity from the user's list of mobile identities. The response is either a SuccessResponse or an ErrorResponse. An ErrorResponse will be returned if any device cannot be deleted because of insufficient privilege. When a delete request is attempted on the primary mobile identity, the delete will fail unless it is the last mobile identity in the user's list. If deleteExistingDevices is set to true, after the mobile identity is deleted, any device that is only used by the deleted mobile identity 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 with the type warning will be returned if any device cannot be deleted 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 @NotNull @Size(min=1,max=23) String	mobileNumber
protected @NotNull @Valid BroadWorksUser	user

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

log

Constructor Summary

Constructors

Constructor	Description
UserBroadWorksMobilityMobileIdentityConsolidatedDeleteRequest()
UserBroadWorksMobilityMobileIdentityConsolidatedDeleteRequest(BroadWorksUser user, String mobileNumber)

Method Summary

Modifier and Type	Method	Description
boolean	deleteExistingDevicesFlagExist()
void	formRequest()	Forms the XML Document for this Request Object.
BroadWorksUser	getBroadWorksUser()
Boolean	getDeleteExistingDevices()
static UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedDeleteRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
String	getMobileNumber()
UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedDeleteRequest	setFlagDeleteExistingDevices()
UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedDeleteRequest	setMobileNumber(String mobileNumber)
UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedDeleteRequest	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, 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 Detail

user

@NotNull
@Valid
protected transient @NotNull @Valid BroadWorksUser user

mobileNumber

@NotNull
@Size(min=1,
      max=23)
protected @NotNull @Size(min=1,max=23) String mobileNumber

deleteExistingDevices

@AssertTrue
protected @AssertTrue Boolean deleteExistingDevices

Constructor Detail

UserBroadWorksMobilityMobileIdentityConsolidatedDeleteRequest

public UserBroadWorksMobilityMobileIdentityConsolidatedDeleteRequest()

UserBroadWorksMobilityMobileIdentityConsolidatedDeleteRequest

public UserBroadWorksMobilityMobileIdentityConsolidatedDeleteRequest(BroadWorksUser user,
                                                                     String mobileNumber)

Method Detail

setUser

public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedDeleteRequest setUser(BroadWorksUser user)

getBroadWorksUser

public BroadWorksUser getBroadWorksUser()

setMobileNumber

public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedDeleteRequest setMobileNumber(String mobileNumber)

getMobileNumber

public String getMobileNumber()

setFlagDeleteExistingDevices

public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityConsolidatedDeleteRequest setFlagDeleteExistingDevices()

deleteExistingDevicesFlagExist

public boolean deleteExistingDevicesFlagExist()

getDeleteExistingDevices

public Boolean getDeleteExistingDevices()

getEmptyObject

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