co.ecg.alpaca.toolkit.generated

Class User.UserPersonalPhoneListModifyRequest

java.lang.Object

co.ecg.alpaca.toolkit.Request<Response.DefaultResponse>

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

All Implemented Interfaces:

Runnable

Enclosing class:

User

public static class User.UserPersonalPhoneListModifyRequest
extends Request<Response.DefaultResponse>

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

Field Summary

Fields

Modifier and Type	Field and Description
String	entryName
boolean	entryNameIsModified
String	newEntryName
boolean	newEntryNameIsModified
String	phoneNumber
boolean	phoneNumberIsModified
User	user
boolean	userIsModified

Constructor Summary

Constructors

Constructor and Description
UserPersonalPhoneListModifyRequest(BroadWorksServer bws) Default Constructor -- Not Guaranteed to work without checking Request validity with isValid()
UserPersonalPhoneListModifyRequest(User user, String entryName)

Method Summary

Modifier and Type	Method and Description
void	formRequest() Forms the XML Document for this Request Object.
String	getEntryName()
String	getNewEntryName()
String	getPhoneNumber()
User	getUser()
User.UserPersonalPhoneListModifyRequest	setEntryName(String entryName)
User.UserPersonalPhoneListModifyRequest	setNewEntryName(String newEntryName)
User.UserPersonalPhoneListModifyRequest	setPhoneNumber(String phoneNumber)
User.UserPersonalPhoneListModifyRequest	setUser(User user)

Methods inherited from class co.ecg.alpaca.toolkit.Request

appendChild, appendChild, appendChild, asyncFire, createElement, createNilElement, createTextElement, fire, fire, getBroadWorksServer, getCommandType, getDomDocument, getResponseClass, isMemberOfBundle, isValid, run, setBroadWorksServer, setCommandElement, setCommandType, setDomDocument, setMemberOfBundle, setRequestId, setResponseClass, setRootElement, toString, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

user

@NotNull
public User user

userIsModified

public transient boolean userIsModified

entryName

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

entryNameIsModified

public transient boolean entryNameIsModified

newEntryName

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

newEntryNameIsModified

public transient boolean newEntryNameIsModified

phoneNumber

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

phoneNumberIsModified

public transient boolean phoneNumberIsModified

Constructor Detail

UserPersonalPhoneListModifyRequest

public UserPersonalPhoneListModifyRequest(User user,
                                          String entryName)

UserPersonalPhoneListModifyRequest

public UserPersonalPhoneListModifyRequest(BroadWorksServer bws)

Default Constructor -- Not Guaranteed to work without checking Request validity with isValid()

Parameters:

bws - The BroadWorksServer to use for the Request

Method Detail

setUser

public User.UserPersonalPhoneListModifyRequest setUser(User user)

getUser

public User getUser()

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()

formRequest

public void formRequest()
                 throws RequestException

Forms the XML Document for this Request Object. Called by the Request upon fire().

Specified by:

formRequest in class Request<Response.DefaultResponse>

Throws:

RequestException