Package co.ecg.alpaca.toolkit.generated

Class User.UserAddRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.User.UserAddRequest

Enclosing class:

User

@Choice(minOccurs=0,value={@ChoiceGroup("accessDeviceEndpoint"),@ChoiceGroup("trunkAddressing")})
public static class User.UserAddRequest
extends Request<DefaultResponse>

Request to add a user. The domain is required in the userId. The password is not required if external authentication is enabled. The following elements are only used in AS data mode and will fail in XS data mode: trunkAddressing The following elements are only used in AS data mode and ignored in XS data mode: nameDialingName alternateUserId The following elements are only used in XS data mode and ignored in AS data mode: allowVideo The response is either SuccessResponse or ErrorResponse. The following elements can only be used by a system administrator:. allowVideo alternateUserId The following elements can only be used by a provisioning administrator:. alternateUserId The response is either SuccessResponse or 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 @Valid AccessDeviceMultipleIdentityAndContactEndpointAdd22V2	accessDeviceEndpoint
protected @Valid StreetAddress	address
protected @Size(min=1,max=80) String	addressLocation
protected @Size(max=3) String[]	alias
protected @Valid @Size(max=4) AlternateUserIdEntry[]	alternateUserId
protected @NotNull @Size(min=1,max=30) String	callingLineIdFirstName
protected @NotNull @Size(min=1,max=30) String	callingLineIdLastName
protected @Size(min=1,max=23) String	callingLineIdPhoneNumber
protected @Valid DepartmentKey	department
protected @Size(min=1,max=80) String	emailAddress
protected @Size(min=2,max=20) String	extension
protected @NotNull @Size(min=1,max=30) String	firstName
protected @NotNull @Size(min=1,max=30) String	groupId
protected @Size(min=1,max=30) String	hiraganaFirstName
protected @Size(min=1,max=30) String	hiraganaLastName
protected @Size(min=1,max=40) String	language
protected @NotNull @Size(min=1,max=30) String	lastName
protected @Size(min=1,max=30) String	mobilePhoneNumber
protected @Valid NameDialingName	nameDialingName
protected @Size(min=1,max=40) String	networkClassOfService
protected @Size(min=1,max=30) String	pagerPhoneNumber
protected @Size(min=1,max=60) String	password
protected @Size(min=1,max=23) String	phoneNumber
protected @NotNull @Size(min=1,max=30) String	serviceProviderId
protected @Size(min=1,max=127) String	timeZone
protected @Size(min=1,max=50) String	title
protected @Valid TrunkAddressingMultipleContactAdd22	trunkAddressing
protected @NotNull @Size(min=1,max=161) String	userId
protected @Size(min=1,max=50) String	yahooId

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

log

Constructor Summary

Constructors

Constructor	Description
UserAddRequest()
UserAddRequest(BroadWorksServer broadWorksServer, String serviceProviderId, String groupId, String userId, String lastName, String firstName, String callingLineIdLastName, String callingLineIdFirstName)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
AccessDeviceMultipleIdentityAndContactEndpointAdd22V2	getAccessDeviceEndpoint()
StreetAddress	getAddress()
String	getAddressLocation()
String[]	getAlias()
AlternateUserIdEntry[]	getAlternateUserId()
String	getCallingLineIdFirstName()
String	getCallingLineIdLastName()
String	getCallingLineIdPhoneNumber()
DepartmentKey	getDepartment()
String	getEmailAddress()
static User.UserAddRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
String	getExtension()
String	getFirstName()
String	getGroupId()
String	getHiraganaFirstName()
String	getHiraganaLastName()
String	getLanguage()
String	getLastName()
String	getMobilePhoneNumber()
NameDialingName	getNameDialingName()
String	getNetworkClassOfService()
String	getPagerPhoneNumber()
String	getPassword()
String	getPhoneNumber()
String	getServiceProviderId()
String	getTimeZone()
String	getTitle()
TrunkAddressingMultipleContactAdd22	getTrunkAddressing()
String	getUserId()
String	getYahooId()
User.UserAddRequest	setAccessDeviceEndpoint(AccessDeviceMultipleIdentityAndContactEndpointAdd22V2 accessDeviceEndpoint)
User.UserAddRequest	setAddress(StreetAddress address)
User.UserAddRequest	setAddressLocation(String addressLocation)
User.UserAddRequest	setAlias(String... alias)
User.UserAddRequest	setAlternateUserId(AlternateUserIdEntry... alternateUserId)
User.UserAddRequest	setCallingLineIdFirstName(String callingLineIdFirstName)
User.UserAddRequest	setCallingLineIdLastName(String callingLineIdLastName)
User.UserAddRequest	setCallingLineIdPhoneNumber(String callingLineIdPhoneNumber)
User.UserAddRequest	setDepartment(DepartmentKey department)
User.UserAddRequest	setEmailAddress(String emailAddress)
User.UserAddRequest	setExtension(String extension)
User.UserAddRequest	setFirstName(String firstName)
User.UserAddRequest	setGroupId(String groupId)
User.UserAddRequest	setHiraganaFirstName(String hiraganaFirstName)
User.UserAddRequest	setHiraganaLastName(String hiraganaLastName)
User.UserAddRequest	setLanguage(String language)
User.UserAddRequest	setLastName(String lastName)
User.UserAddRequest	setMobilePhoneNumber(String mobilePhoneNumber)
User.UserAddRequest	setNameDialingName(NameDialingName nameDialingName)
User.UserAddRequest	setNetworkClassOfService(String networkClassOfService)
User.UserAddRequest	setPagerPhoneNumber(String pagerPhoneNumber)
User.UserAddRequest	setPassword(String password)
User.UserAddRequest	setPhoneNumber(String phoneNumber)
User.UserAddRequest	setServiceProviderId(String serviceProviderId)
User.UserAddRequest	setTimeZone(String timeZone)
User.UserAddRequest	setTitle(String title)
User.UserAddRequest	setTrunkAddressing(TrunkAddressingMultipleContactAdd22 trunkAddressing)
User.UserAddRequest	setUserId(String userId)
User.UserAddRequest	setYahooId(String yahooId)

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

serviceProviderId

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

groupId

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

userId

@NotNull
@Pattern(regexp="[a-zA-Z0-9._!~*\'()+-]+@[a-zA-Z0-9.-]+")
@Size(min=1,
      max=161)
protected @NotNull @Size(min=1,max=161) String userId

lastName

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

firstName

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

callingLineIdLastName

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

callingLineIdFirstName

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

nameDialingName

@Valid
protected @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

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

extension

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

callingLineIdPhoneNumber

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

password

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

department

@Valid
protected @Valid DepartmentKey department

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

alias

@Size(max=3)
@StringArrayElementSize(min=1,
                        max=161)
protected @Size(max=3) String[] alias

accessDeviceEndpoint

@Valid
protected @Valid AccessDeviceMultipleIdentityAndContactEndpointAdd22V2 accessDeviceEndpoint

trunkAddressing

@Valid
protected @Valid TrunkAddressingMultipleContactAdd22 trunkAddressing

title

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

pagerPhoneNumber

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

mobilePhoneNumber

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

emailAddress

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

yahooId

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

addressLocation

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

alternateUserId

@Valid
@Size(max=4)
protected @Valid @Size(max=4) AlternateUserIdEntry[] alternateUserId

Constructor Details

UserAddRequest

public UserAddRequest()

UserAddRequest

public UserAddRequest(BroadWorksServer broadWorksServer,
 String serviceProviderId,
 String groupId,
 String userId,
 String lastName,
 String firstName,
 String callingLineIdLastName,
 String callingLineIdFirstName)

Method Details

setServiceProviderId

public User.UserAddRequest setServiceProviderId(String serviceProviderId)

getServiceProviderId

public String getServiceProviderId()

setGroupId

public User.UserAddRequest setGroupId(String groupId)

getGroupId

public String getGroupId()

setUserId

public User.UserAddRequest setUserId(String userId)

getUserId

public String getUserId()

setLastName

public User.UserAddRequest setLastName(String lastName)

getLastName

public String getLastName()

setFirstName

public User.UserAddRequest setFirstName(String firstName)

getFirstName

public String getFirstName()

setCallingLineIdLastName

public User.UserAddRequest setCallingLineIdLastName(String callingLineIdLastName)

getCallingLineIdLastName

public String getCallingLineIdLastName()

setCallingLineIdFirstName

public User.UserAddRequest setCallingLineIdFirstName(String callingLineIdFirstName)

getCallingLineIdFirstName

public String getCallingLineIdFirstName()

setNameDialingName

public User.UserAddRequest setNameDialingName(NameDialingName nameDialingName)

getNameDialingName

public NameDialingName getNameDialingName()

setHiraganaLastName

public User.UserAddRequest setHiraganaLastName(String hiraganaLastName)

getHiraganaLastName

public String getHiraganaLastName()

setHiraganaFirstName

public User.UserAddRequest setHiraganaFirstName(String hiraganaFirstName)

getHiraganaFirstName

public String getHiraganaFirstName()

setPhoneNumber

public User.UserAddRequest setPhoneNumber(String phoneNumber)

getPhoneNumber

public String getPhoneNumber()

setExtension

public User.UserAddRequest setExtension(String extension)

getExtension

public String getExtension()

setCallingLineIdPhoneNumber

public User.UserAddRequest setCallingLineIdPhoneNumber(String callingLineIdPhoneNumber)

getCallingLineIdPhoneNumber

public String getCallingLineIdPhoneNumber()

setPassword

public User.UserAddRequest setPassword(String password)

getPassword

public String getPassword()

setDepartment

public User.UserAddRequest setDepartment(DepartmentKey department)

getDepartment

public DepartmentKey getDepartment()

setLanguage

public User.UserAddRequest setLanguage(String language)

getLanguage

public String getLanguage()

setTimeZone

public User.UserAddRequest setTimeZone(String timeZone)

getTimeZone

public String getTimeZone()

setAlias

public User.UserAddRequest setAlias(String... alias)

getAlias

public String[] getAlias()

setAccessDeviceEndpoint

public User.UserAddRequest setAccessDeviceEndpoint(AccessDeviceMultipleIdentityAndContactEndpointAdd22V2 accessDeviceEndpoint)

getAccessDeviceEndpoint

public AccessDeviceMultipleIdentityAndContactEndpointAdd22V2 getAccessDeviceEndpoint()

setTrunkAddressing

public User.UserAddRequest setTrunkAddressing(TrunkAddressingMultipleContactAdd22 trunkAddressing)

getTrunkAddressing

public TrunkAddressingMultipleContactAdd22 getTrunkAddressing()

setTitle

public User.UserAddRequest setTitle(String title)

getTitle

public String getTitle()

setPagerPhoneNumber

public User.UserAddRequest setPagerPhoneNumber(String pagerPhoneNumber)

getPagerPhoneNumber

public String getPagerPhoneNumber()

setMobilePhoneNumber

public User.UserAddRequest setMobilePhoneNumber(String mobilePhoneNumber)

getMobilePhoneNumber

public String getMobilePhoneNumber()

setEmailAddress

public User.UserAddRequest setEmailAddress(String emailAddress)

getEmailAddress

public String getEmailAddress()

setYahooId

public User.UserAddRequest setYahooId(String yahooId)

getYahooId

public String getYahooId()

setAddressLocation

public User.UserAddRequest setAddressLocation(String addressLocation)

getAddressLocation

public String getAddressLocation()

setAddress

public User.UserAddRequest setAddress(StreetAddress address)

getAddress

public StreetAddress getAddress()

setNetworkClassOfService

public User.UserAddRequest setNetworkClassOfService(String networkClassOfService)

getNetworkClassOfService

public String getNetworkClassOfService()

setAlternateUserId

public User.UserAddRequest setAlternateUserId(AlternateUserIdEntry... alternateUserId)

getAlternateUserId

public AlternateUserIdEntry[] getAlternateUserId()

getEmptyObject

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