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

Class UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityDeleteRequest

java.lang.Object

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

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

Enclosing class:

UserBroadWorksMobility

public static class UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityDeleteRequest
extends Request<DefaultResponse>

Delete a mobile identity from the user's list of mobile identities. The response is either a SuccessResponse or an ErrorResponse. If another Mobile Identity is set to ring mobile only and only has this mobile identity in the alerting list, the identity is deleted and ErrorResponse is returned. The ErrorResponse is info type and contains the affected mobile numbers in the summary. 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.

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 @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
UserBroadWorksMobilityMobileIdentityDeleteRequest()
UserBroadWorksMobilityMobileIdentityDeleteRequest(BroadWorksUser user, String mobileNumber)

Method Summary

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

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

Constructor Details

UserBroadWorksMobilityMobileIdentityDeleteRequest

public UserBroadWorksMobilityMobileIdentityDeleteRequest()

UserBroadWorksMobilityMobileIdentityDeleteRequest

public UserBroadWorksMobilityMobileIdentityDeleteRequest(BroadWorksUser user,
 String mobileNumber)

Method Details

setUser

public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityDeleteRequest setUser(BroadWorksUser user)

getBroadWorksUser

public BroadWorksUser getBroadWorksUser()

setMobileNumber

public UserBroadWorksMobility.UserBroadWorksMobilityMobileIdentityDeleteRequest setMobileNumber(String mobileNumber)

getMobileNumber

public String getMobileNumber()

getEmptyObject

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