Package 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

Enclosing class:

User

public static class User.UserModifyRequest
extends Request<DefaultResponse>

The following data elements are only used in AS data mode: contact[2]-contact[5] The following elements are only used in AS data mode and will fail in XS data mode: trunkAddressing newUserExternalId The following elements are only used in AS data mode and ignored in XS data mode: nameDialingName alternateUserIdList newUserExternalId The following elements are only used in XS data mode and ignored in AS data mode: allowVideo The allowVideo element can only be used by a system administrator. 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.

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 @Valid StreetAddress	address
protected Optional<@Size(min=1,max=80) String>	addressLocation
protected Boolean	allowVideo
protected Optional<@Valid ReplacementAlternateUserIdEntryList>	alternateUserIdList
protected @Size(min=1,max=30) String	callingLineIdFirstName
protected @Size(min=1,max=30) String	callingLineIdLastName
protected Optional<@Size(min=1,max=23) String>	callingLineIdPhoneNumber
Optional<@Valid DepartmentKey>	department
protected Class<? extends DepartmentKey>	departmentType
protected Optional<@Size(min=1,max=80) String>	emailAddress
protected Optional<@Valid Endpoint1>	endpoint
protected Optional<@Size(min=2,max=20) String>	extension
protected @Size(min=1,max=30) String	firstName
protected @Size(min=1,max=30) String	hiraganaFirstName
protected @Size(min=1,max=30) String	hiraganaLastName
protected Optional<@Size(min=1,max=196) String>	impId
protected Optional<@Size(min=1,max=60) String>	impPassword
protected @Size(min=1,max=40) String	language
protected @Size(min=1,max=30) String	lastName
protected Optional<@Size(min=1,max=30) String>	mobilePhoneNumber
protected Optional<@Valid NameDialingName>	nameDialingName
protected @Size(min=1,max=40) String	networkClassOfService
protected Optional<@Size(min=1,max=60) String>	newPassword
protected @Size(max=36) String	newUserExternalId
protected @Size(min=1,max=40) String	officeZoneName
protected @Size(min=1,max=60) String	oldPassword
protected Optional<@Size(min=1,max=30) String>	pagerPhoneNumber
protected Optional<@Size(min=1,max=23) String>	phoneNumber
protected @Size(min=1,max=80) String	primaryZoneName
protected Optional<@Valid ReplacementSIPAliasList>	sipAliasList
protected @Size(min=1,max=127) String	timeZone
protected Optional<@Size(min=1,max=50) String>	title
protected @NotNull @Valid BroadWorksUser	user
protected Optional<@Size(min=1,max=50) String>	yahooId

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

log

Constructor Summary

Constructors

Constructor	Description
UserModifyRequest()
UserModifyRequest(BroadWorksUser user)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
StreetAddress	getAddress()
Optional<@Size(min=1,max=80) String>	getAddressLocation()
Boolean	getAllowVideo()
Optional<@Valid ReplacementAlternateUserIdEntryList>	getAlternateUserIdList()
BroadWorksUser	getBroadWorksUser()
String	getCallingLineIdFirstName()
String	getCallingLineIdLastName()
Optional<@Size(min=1,max=23) String>	getCallingLineIdPhoneNumber()
Optional<@Valid DepartmentKey>	getDepartment()
Optional<@Size(min=1,max=80) String>	getEmailAddress()
static User.UserModifyRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
Optional<@Valid Endpoint1>	getEndpoint()
Optional<@Size(min=2,max=20) String>	getExtension()
String	getFirstName()
String	getHiraganaFirstName()
String	getHiraganaLastName()
Optional<@Size(min=1,max=196) String>	getImpId()
Optional<@Size(min=1,max=60) String>	getImpPassword()
String	getLanguage()
String	getLastName()
Optional<@Size(min=1,max=30) String>	getMobilePhoneNumber()
Optional<@Valid NameDialingName>	getNameDialingName()
String	getNetworkClassOfService()
Optional<@Size(min=1,max=60) String>	getNewPassword()
String	getNewUserExternalId()
String	getOfficeZoneName()
String	getOldPassword()
Optional<@Size(min=1,max=30) String>	getPagerPhoneNumber()
Optional<@Size(min=1,max=23) String>	getPhoneNumber()
String	getPrimaryZoneName()
Optional<@Valid ReplacementSIPAliasList>	getSipAliasList()
String	getTimeZone()
Optional<@Size(min=1,max=50) String>	getTitle()
Optional<@Size(min=1,max=50) String>	getYahooId()
User.UserModifyRequest	setAddress(StreetAddress address)
User.UserModifyRequest	setAddressLocation(String addressLocation)
User.UserModifyRequest	setAllowVideo(Boolean allowVideo)
User.UserModifyRequest	setAlternateUserIdList(ReplacementAlternateUserIdEntryList alternateUserIdList)
User.UserModifyRequest	setCallingLineIdFirstName(String callingLineIdFirstName)
User.UserModifyRequest	setCallingLineIdLastName(String callingLineIdLastName)
User.UserModifyRequest	setCallingLineIdPhoneNumber(String callingLineIdPhoneNumber)
User.UserModifyRequest	setDepartment(DepartmentKey department)
User.UserModifyRequest	setDepartment(DepartmentKey department, Class<? extends DepartmentKey> departmentType)
User.UserModifyRequest	setEmailAddress(String emailAddress)
User.UserModifyRequest	setEndpoint(Endpoint1 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	setNewUserExternalId(String newUserExternalId)
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(BroadWorksUser user)
User.UserModifyRequest	setYahooId(String yahooId)
User.UserModifyRequest	unsetAddressLocation()
User.UserModifyRequest	unsetAlternateUserIdList()
User.UserModifyRequest	unsetCallingLineIdPhoneNumber()
User.UserModifyRequest	unsetDepartment()
User.UserModifyRequest	unsetEmailAddress()
User.UserModifyRequest	unsetEndpoint()
User.UserModifyRequest	unsetExtension()
User.UserModifyRequest	unsetImpId()
User.UserModifyRequest	unsetImpPassword()
User.UserModifyRequest	unsetMobilePhoneNumber()
User.UserModifyRequest	unsetNameDialingName()
User.UserModifyRequest	unsetNewPassword()
User.UserModifyRequest	unsetPagerPhoneNumber()
User.UserModifyRequest	unsetPhoneNumber()
User.UserModifyRequest	unsetSipAliasList()
User.UserModifyRequest	unsetTitle()
User.UserModifyRequest	unsetYahooId()

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

lastName

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

firstName

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

callingLineIdLastName

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

callingLineIdFirstName

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

nameDialingName

protected Optional<@Valid NameDialingName> nameDialingName

hiraganaLastName

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

hiraganaFirstName

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

phoneNumber

protected Optional<@Size(min=1,max=23) String> phoneNumber

extension

protected Optional<@Size(min=2,max=20) String> extension

callingLineIdPhoneNumber

protected Optional<@Size(min=1,max=23) String> callingLineIdPhoneNumber

oldPassword

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

newPassword

protected Optional<@Size(min=1,max=60) String> newPassword

department

public Optional<@Valid DepartmentKey> department

departmentType

protected Class<? extends DepartmentKey> departmentType

language

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

timeZone

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

sipAliasList

protected Optional<@Valid ReplacementSIPAliasList> sipAliasList

endpoint

protected Optional<@Valid Endpoint1> endpoint

title

protected Optional<@Size(min=1,max=50) String> title

pagerPhoneNumber

protected Optional<@Size(min=1,max=30) String> pagerPhoneNumber

mobilePhoneNumber

protected Optional<@Size(min=1,max=30) String> mobilePhoneNumber

emailAddress

protected Optional<@Size(min=1,max=80) String> emailAddress

yahooId

protected Optional<@Size(min=1,max=50) String> yahooId

addressLocation

protected Optional<@Size(min=1,max=80) String> addressLocation

address

@Valid
protected @Valid StreetAddress address

networkClassOfService

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

officeZoneName

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

primaryZoneName

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

impId

protected Optional<@Size(min=1,max=196) String> impId

impPassword

protected Optional<@Size(min=1,max=60) String> impPassword

alternateUserIdList

protected Optional<@Valid ReplacementAlternateUserIdEntryList> alternateUserIdList

allowVideo

protected Boolean allowVideo

newUserExternalId

@Size(max=36)
protected @Size(max=36) String newUserExternalId

Constructor Details

UserModifyRequest

public UserModifyRequest()

UserModifyRequest

public UserModifyRequest(BroadWorksUser user)

Method Details

setUser

public User.UserModifyRequest setUser(BroadWorksUser user)

getBroadWorksUser

public BroadWorksUser getBroadWorksUser()

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

unsetNameDialingName

public User.UserModifyRequest unsetNameDialingName()

setNameDialingName

public User.UserModifyRequest setNameDialingName(NameDialingName nameDialingName)

getNameDialingName

public Optional<@Valid NameDialingName> getNameDialingName()

setHiraganaLastName

public User.UserModifyRequest setHiraganaLastName(String hiraganaLastName)

getHiraganaLastName

public String getHiraganaLastName()

setHiraganaFirstName

public User.UserModifyRequest setHiraganaFirstName(String hiraganaFirstName)

getHiraganaFirstName

public String getHiraganaFirstName()

unsetPhoneNumber

public User.UserModifyRequest unsetPhoneNumber()

setPhoneNumber

public User.UserModifyRequest setPhoneNumber(String phoneNumber)

getPhoneNumber

public Optional<@Size(min=1,max=23) String> getPhoneNumber()

unsetExtension

public User.UserModifyRequest unsetExtension()

setExtension

public User.UserModifyRequest setExtension(String extension)

getExtension

public Optional<@Size(min=2,max=20) String> getExtension()

unsetCallingLineIdPhoneNumber

public User.UserModifyRequest unsetCallingLineIdPhoneNumber()

setCallingLineIdPhoneNumber

public User.UserModifyRequest setCallingLineIdPhoneNumber(String callingLineIdPhoneNumber)

getCallingLineIdPhoneNumber

public Optional<@Size(min=1,max=23) String> getCallingLineIdPhoneNumber()

setOldPassword

public User.UserModifyRequest setOldPassword(String oldPassword)

getOldPassword

public String getOldPassword()

unsetNewPassword

public User.UserModifyRequest unsetNewPassword()

setNewPassword

public User.UserModifyRequest setNewPassword(String newPassword)

getNewPassword

public Optional<@Size(min=1,max=60) String> getNewPassword()

unsetDepartment

public User.UserModifyRequest unsetDepartment()

setDepartment

public User.UserModifyRequest setDepartment(DepartmentKey department,
 Class<? extends DepartmentKey> departmentType)

setDepartment

public User.UserModifyRequest setDepartment(DepartmentKey department)

getDepartment

public Optional<@Valid DepartmentKey> getDepartment()

setLanguage

public User.UserModifyRequest setLanguage(String language)

getLanguage

public String getLanguage()

setTimeZone

public User.UserModifyRequest setTimeZone(String timeZone)

getTimeZone

public String getTimeZone()

unsetSipAliasList

public User.UserModifyRequest unsetSipAliasList()

setSipAliasList

public User.UserModifyRequest setSipAliasList(ReplacementSIPAliasList sipAliasList)

getSipAliasList

public Optional<@Valid ReplacementSIPAliasList> getSipAliasList()

unsetEndpoint

public User.UserModifyRequest unsetEndpoint()

setEndpoint

public User.UserModifyRequest setEndpoint(Endpoint1 endpoint)

getEndpoint

public Optional<@Valid Endpoint1> getEndpoint()

unsetTitle

public User.UserModifyRequest unsetTitle()

setTitle

public User.UserModifyRequest setTitle(String title)

getTitle

public Optional<@Size(min=1,max=50) String> getTitle()

unsetPagerPhoneNumber

public User.UserModifyRequest unsetPagerPhoneNumber()

setPagerPhoneNumber

public User.UserModifyRequest setPagerPhoneNumber(String pagerPhoneNumber)

getPagerPhoneNumber

public Optional<@Size(min=1,max=30) String> getPagerPhoneNumber()

unsetMobilePhoneNumber

public User.UserModifyRequest unsetMobilePhoneNumber()

setMobilePhoneNumber

public User.UserModifyRequest setMobilePhoneNumber(String mobilePhoneNumber)

getMobilePhoneNumber

public Optional<@Size(min=1,max=30) String> getMobilePhoneNumber()

unsetEmailAddress

public User.UserModifyRequest unsetEmailAddress()

setEmailAddress

public User.UserModifyRequest setEmailAddress(String emailAddress)

getEmailAddress

public Optional<@Size(min=1,max=80) String> getEmailAddress()

unsetYahooId

public User.UserModifyRequest unsetYahooId()

setYahooId

public User.UserModifyRequest setYahooId(String yahooId)

getYahooId

public Optional<@Size(min=1,max=50) String> getYahooId()

unsetAddressLocation

public User.UserModifyRequest unsetAddressLocation()

setAddressLocation

public User.UserModifyRequest setAddressLocation(String addressLocation)

getAddressLocation

public Optional<@Size(min=1,max=80) 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()

unsetImpId

public User.UserModifyRequest unsetImpId()

setImpId

public User.UserModifyRequest setImpId(String impId)

getImpId

public Optional<@Size(min=1,max=196) String> getImpId()

unsetImpPassword

public User.UserModifyRequest unsetImpPassword()

setImpPassword

public User.UserModifyRequest setImpPassword(String impPassword)

getImpPassword

public Optional<@Size(min=1,max=60) String> getImpPassword()

unsetAlternateUserIdList

public User.UserModifyRequest unsetAlternateUserIdList()

setAlternateUserIdList

public User.UserModifyRequest setAlternateUserIdList(ReplacementAlternateUserIdEntryList alternateUserIdList)

getAlternateUserIdList

public Optional<@Valid ReplacementAlternateUserIdEntryList> getAlternateUserIdList()

setAllowVideo

public User.UserModifyRequest setAllowVideo(Boolean allowVideo)

getAllowVideo

public Boolean getAllowVideo()

setNewUserExternalId

public User.UserModifyRequest setNewUserExternalId(String newUserExternalId)

getNewUserExternalId

public String getNewUserExternalId()

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>