Package co.ecg.alpaca.toolkit.generated

Class User.UserPersonalPhoneListModifyRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.User.UserPersonalPhoneListModifyRequest

Enclosing class:

User

public static class User.UserPersonalPhoneListModifyRequest
extends Request<DefaultResponse>

Modify an entry in a user's personal phone list. The response is either a SuccessResponse or an ErrorResponse.

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=50) String	entryName
protected @Size(min=1,max=50) String	newEntryName
protected @Size(min=1,max=30) String	phoneNumber
protected @NotNull @Valid BroadWorksUser	user

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

log

Constructor Summary

Constructors

Constructor	Description
UserPersonalPhoneListModifyRequest()
UserPersonalPhoneListModifyRequest(BroadWorksUser user, String entryName)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
BroadWorksUser	getBroadWorksUser()
static User.UserPersonalPhoneListModifyRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
String	getEntryName()
String	getNewEntryName()
String	getPhoneNumber()
User.UserPersonalPhoneListModifyRequest	setEntryName(String entryName)
User.UserPersonalPhoneListModifyRequest	setNewEntryName(String newEntryName)
User.UserPersonalPhoneListModifyRequest	setPhoneNumber(String phoneNumber)
User.UserPersonalPhoneListModifyRequest	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

entryName

@NotNull
@Size(min=1,
      max=50)
protected @NotNull @Size(min=1,max=50) String entryName

newEntryName

@Size(min=1,
      max=50)
protected @Size(min=1,max=50) String newEntryName

phoneNumber

@Size(min=1,
      max=30)
protected @Size(min=1,max=30) String phoneNumber

Constructor Details

UserPersonalPhoneListModifyRequest

public UserPersonalPhoneListModifyRequest()

UserPersonalPhoneListModifyRequest

public UserPersonalPhoneListModifyRequest(BroadWorksUser user,
 String entryName)

Method Details

setUser

public User.UserPersonalPhoneListModifyRequest setUser(BroadWorksUser user)

getBroadWorksUser

public BroadWorksUser getBroadWorksUser()

setEntryName

public User.UserPersonalPhoneListModifyRequest setEntryName(String entryName)

getEntryName

public String getEntryName()

setNewEntryName

public User.UserPersonalPhoneListModifyRequest setNewEntryName(String newEntryName)

getNewEntryName

public String getNewEntryName()

setPhoneNumber

public User.UserPersonalPhoneListModifyRequest setPhoneNumber(String phoneNumber)

getPhoneNumber

public String getPhoneNumber()

getEmptyObject

public static User.UserPersonalPhoneListModifyRequest 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>