co.ecg.alpaca.toolkit.generated

Class User.UserModifyRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.User.UserModifyRequest

All Implemented Interfaces:

Runnable

Enclosing class:

User

@GwtIncompatible
public static class User.UserModifyRequest
extends Request<DefaultResponse>

AlpacaLibrary Auto-Generated Java File Request to modify a user. When oldPassword is specified, all password rule applies. If oldPassword in not specified, any password rule related to old password does not apply. The request will fail if officeZoneName or primaryZoneName is present but the Location-Based Calling Restrictions service is not assigned to the user. The response is either SuccessResponse or ErrorResponse. The following data elements are only used in AS data mode: contact[2]-contact[5] The impId and impPassword are accepted when the Third-Party IMP service is assigned to the user; when Integrated IMP service is assigned to the user and active, only the impPassword is accepted; all other cases, the request fails if either field is changed.

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 and Description
protected StreetAddress	address
protected com.google.common.base.Optional<String>	addressLocation
protected String	callingLineIdFirstName
protected String	callingLineIdLastName
protected com.google.common.base.Optional<String>	callingLineIdPhoneNumber
protected com.google.common.base.Optional<DepartmentKey>	department
protected com.google.common.base.Optional<String>	emailAddress
protected com.google.common.base.Optional<Endpoint>	endpoint
protected com.google.common.base.Optional<String>	extension
protected String	firstName
protected String	hiraganaFirstName
protected String	hiraganaLastName
protected com.google.common.base.Optional<String>	impId
protected com.google.common.base.Optional<String>	impPassword
protected String	language
protected String	lastName
protected com.google.common.base.Optional<String>	mobilePhoneNumber
protected com.google.common.base.Optional<NameDialingName>	nameDialingName
protected String	networkClassOfService
protected com.google.common.base.Optional<String>	newPassword
protected String	officeZoneName
protected String	oldPassword
protected com.google.common.base.Optional<String>	pagerPhoneNumber
protected com.google.common.base.Optional<String>	phoneNumber
protected String	primaryZoneName
protected com.google.common.base.Optional<ReplacementSIPAliasList>	sipAliasList
protected String	timeZone
protected com.google.common.base.Optional<String>	title
protected User	user
protected com.google.common.base.Optional<String>	yahooId

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

log

Constructor Summary

Constructors

Constructor and Description
UserModifyRequest(User user)

Method Summary

Modifier and Type	Method and Description
void	formRequest() Forms the XML Document for this Request Object.
StreetAddress	getAddress()
com.google.common.base.Optional<String>	getAddressLocation()
String	getCallingLineIdFirstName()
String	getCallingLineIdLastName()
com.google.common.base.Optional<String>	getCallingLineIdPhoneNumber()
com.google.common.base.Optional<DepartmentKey>	getDepartment()
com.google.common.base.Optional<String>	getEmailAddress()
static User.UserModifyRequest	getEmptyObject(BroadWorksServer broadWorksServer) Retrieves this object with minimal setup.
com.google.common.base.Optional<Endpoint>	getEndpoint()
com.google.common.base.Optional<String>	getExtension()
String	getFirstName()
String	getHiraganaFirstName()
String	getHiraganaLastName()
com.google.common.base.Optional<String>	getImpId()
com.google.common.base.Optional<String>	getImpPassword()
String	getLanguage()
String	getLastName()
com.google.common.base.Optional<String>	getMobilePhoneNumber()
com.google.common.base.Optional<NameDialingName>	getNameDialingName()
String	getNetworkClassOfService()
com.google.common.base.Optional<String>	getNewPassword()
String	getOfficeZoneName()
String	getOldPassword()
com.google.common.base.Optional<String>	getPagerPhoneNumber()
com.google.common.base.Optional<String>	getPhoneNumber()
String	getPrimaryZoneName()
com.google.common.base.Optional<ReplacementSIPAliasList>	getSipAliasList()
String	getTimeZone()
com.google.common.base.Optional<String>	getTitle()
User	getUser()
com.google.common.base.Optional<String>	getYahooId()
User.UserModifyRequest	setAddress(StreetAddress address)
User.UserModifyRequest	setAddressLocation(String addressLocation)
User.UserModifyRequest	setCallingLineIdFirstName(String callingLineIdFirstName)
User.UserModifyRequest	setCallingLineIdLastName(String callingLineIdLastName)
User.UserModifyRequest	setCallingLineIdPhoneNumber(String callingLineIdPhoneNumber)
User.UserModifyRequest	setDepartment(DepartmentKey department)
User.UserModifyRequest	setEmailAddress(String emailAddress)
User.UserModifyRequest	setEndpoint(Endpoint endpoint)
User.UserModifyRequest	setExtension(String extension)
User.UserModifyRequest	setFirstName(String firstName)
User.UserModifyRequest	setHiraganaFirstName(String hiraganaFirstName)
User.UserModifyRequest	setHiraganaLastName(String hiraganaLastName)
User.UserModifyRequest	setImpId(String impId)
User.UserModifyRequest	setImpPassword(String impPassword)
User.UserModifyRequest	setLanguage(String language)
User.UserModifyRequest	setLastName(String lastName)
User.UserModifyRequest	setMobilePhoneNumber(String mobilePhoneNumber)
User.UserModifyRequest	setNameDialingName(NameDialingName nameDialingName)
User.UserModifyRequest	setNetworkClassOfService(String networkClassOfService)
User.UserModifyRequest	setNewPassword(String newPassword)
User.UserModifyRequest	setOfficeZoneName(String officeZoneName)
User.UserModifyRequest	setOldPassword(String oldPassword)
User.UserModifyRequest	setPagerPhoneNumber(String pagerPhoneNumber)
User.UserModifyRequest	setPhoneNumber(String phoneNumber)
User.UserModifyRequest	setPrimaryZoneName(String primaryZoneName)
User.UserModifyRequest	setSipAliasList(ReplacementSIPAliasList sipAliasList)
User.UserModifyRequest	setTimeZone(String timeZone)
User.UserModifyRequest	setTitle(String title)
User.UserModifyRequest	setUser(User user)
User.UserModifyRequest	setYahooId(String yahooId)

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

appendChild, appendChild, appendChild, asyncFire, createDocument, createElement, createNilElement, createTextElement, fire, fire, getBroadWorksServer, getCommandElement, getCommandType, getDomDocument, getId, getResponseClass, getRootElement, 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
protected transient User user

lastName

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

firstName

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

callingLineIdLastName

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

callingLineIdFirstName

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

nameDialingName

protected com.google.common.base.Optional<NameDialingName> nameDialingName

hiraganaLastName

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

hiraganaFirstName

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

phoneNumber

protected com.google.common.base.Optional<String> phoneNumber

extension

protected com.google.common.base.Optional<String> extension

callingLineIdPhoneNumber

protected com.google.common.base.Optional<String> callingLineIdPhoneNumber

oldPassword

@Size(min=1,
      max=60)
protected String oldPassword

newPassword

protected com.google.common.base.Optional<String> newPassword

department

protected com.google.common.base.Optional<DepartmentKey> department

language

@Size(min=1,
      max=40)
protected String language

timeZone

@Size(min=1,
      max=127)
protected String timeZone

sipAliasList

protected com.google.common.base.Optional<ReplacementSIPAliasList> sipAliasList

endpoint

protected com.google.common.base.Optional<Endpoint> endpoint

title

protected com.google.common.base.Optional<String> title

pagerPhoneNumber

protected com.google.common.base.Optional<String> pagerPhoneNumber

mobilePhoneNumber

protected com.google.common.base.Optional<String> mobilePhoneNumber

emailAddress

protected com.google.common.base.Optional<String> emailAddress

yahooId

protected com.google.common.base.Optional<String> yahooId

addressLocation

protected com.google.common.base.Optional<String> addressLocation

address

protected StreetAddress address

networkClassOfService

@Size(min=1,
      max=40)
protected String networkClassOfService

officeZoneName

@Size(min=1,
      max=40)
protected String officeZoneName

primaryZoneName

@Size(min=1,
      max=80)
protected String primaryZoneName

impId

protected com.google.common.base.Optional<String> impId

impPassword

protected com.google.common.base.Optional<String> impPassword

Constructor Detail

UserModifyRequest

public UserModifyRequest(User user)

Method Detail

setUser

public User.UserModifyRequest setUser(User user)

getUser

public User getUser()

setLastName

public User.UserModifyRequest setLastName(String lastName)

getLastName

public String getLastName()

setFirstName

public User.UserModifyRequest setFirstName(String firstName)

getFirstName

public String getFirstName()

setCallingLineIdLastName

public User.UserModifyRequest setCallingLineIdLastName(String callingLineIdLastName)

getCallingLineIdLastName

public String getCallingLineIdLastName()

setCallingLineIdFirstName

public User.UserModifyRequest setCallingLineIdFirstName(String callingLineIdFirstName)

getCallingLineIdFirstName

public String getCallingLineIdFirstName()

setNameDialingName

public User.UserModifyRequest setNameDialingName(NameDialingName nameDialingName)

getNameDialingName

public com.google.common.base.Optional<NameDialingName> getNameDialingName()

setHiraganaLastName

public User.UserModifyRequest setHiraganaLastName(String hiraganaLastName)

getHiraganaLastName

public String getHiraganaLastName()

setHiraganaFirstName

public User.UserModifyRequest setHiraganaFirstName(String hiraganaFirstName)

getHiraganaFirstName

public String getHiraganaFirstName()

setPhoneNumber

public User.UserModifyRequest setPhoneNumber(String phoneNumber)

getPhoneNumber

public com.google.common.base.Optional<String> getPhoneNumber()

setExtension

public User.UserModifyRequest setExtension(String extension)

getExtension

public com.google.common.base.Optional<String> getExtension()

setCallingLineIdPhoneNumber

public User.UserModifyRequest setCallingLineIdPhoneNumber(String callingLineIdPhoneNumber)

getCallingLineIdPhoneNumber

public com.google.common.base.Optional<String> getCallingLineIdPhoneNumber()

setOldPassword

public User.UserModifyRequest setOldPassword(String oldPassword)

getOldPassword

public String getOldPassword()

setNewPassword

public User.UserModifyRequest setNewPassword(String newPassword)

getNewPassword

public com.google.common.base.Optional<String> getNewPassword()

setDepartment

public User.UserModifyRequest setDepartment(DepartmentKey department)

getDepartment

public com.google.common.base.Optional<DepartmentKey> getDepartment()

setLanguage

public User.UserModifyRequest setLanguage(String language)

getLanguage

public String getLanguage()

setTimeZone

public User.UserModifyRequest setTimeZone(String timeZone)

getTimeZone

public String getTimeZone()

setSipAliasList

public User.UserModifyRequest setSipAliasList(ReplacementSIPAliasList sipAliasList)

getSipAliasList

public com.google.common.base.Optional<ReplacementSIPAliasList> getSipAliasList()

setEndpoint

public User.UserModifyRequest setEndpoint(Endpoint endpoint)

getEndpoint

public com.google.common.base.Optional<Endpoint> getEndpoint()

setTitle

public User.UserModifyRequest setTitle(String title)

getTitle

public com.google.common.base.Optional<String> getTitle()

setPagerPhoneNumber

public User.UserModifyRequest setPagerPhoneNumber(String pagerPhoneNumber)

getPagerPhoneNumber

public com.google.common.base.Optional<String> getPagerPhoneNumber()

setMobilePhoneNumber

public User.UserModifyRequest setMobilePhoneNumber(String mobilePhoneNumber)

getMobilePhoneNumber

public com.google.common.base.Optional<String> getMobilePhoneNumber()

setEmailAddress

public User.UserModifyRequest setEmailAddress(String emailAddress)

getEmailAddress

public com.google.common.base.Optional<String> getEmailAddress()

setYahooId

public User.UserModifyRequest setYahooId(String yahooId)

getYahooId

public com.google.common.base.Optional<String> getYahooId()

setAddressLocation

public User.UserModifyRequest setAddressLocation(String addressLocation)

getAddressLocation

public com.google.common.base.Optional<String> getAddressLocation()

setAddress

public User.UserModifyRequest setAddress(StreetAddress address)

getAddress

public StreetAddress getAddress()

setNetworkClassOfService

public User.UserModifyRequest setNetworkClassOfService(String networkClassOfService)

getNetworkClassOfService

public String getNetworkClassOfService()

setOfficeZoneName

public User.UserModifyRequest setOfficeZoneName(String officeZoneName)

getOfficeZoneName

public String getOfficeZoneName()

setPrimaryZoneName

public User.UserModifyRequest setPrimaryZoneName(String primaryZoneName)

getPrimaryZoneName

public String getPrimaryZoneName()

setImpId

public User.UserModifyRequest setImpId(String impId)

getImpId

public com.google.common.base.Optional<String> getImpId()

setImpPassword

public User.UserModifyRequest setImpPassword(String impPassword)

getImpPassword

public com.google.common.base.Optional<String> getImpPassword()

getEmptyObject

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