Package co.ecg.alpaca.toolkit.generated

Class User.UserPhoneDirectoryGetSearchedListRequest

java.lang.Object

co.ecg.alpaca.toolkit.messaging.request.Request<User.UserPhoneDirectoryGetSearchedListResponse>

co.ecg.alpaca.toolkit.generated.User.UserPhoneDirectoryGetSearchedListRequest

Enclosing class:

User

public static class User.UserPhoneDirectoryGetSearchedListRequest
extends Request<User.UserPhoneDirectoryGetSearchedListResponse>

Request a table containing the phone directory for a user. If the specified user is part of an enterprise, the directory includes all users in the enterprise and all entries in the enterprise common phone list and the common phone list of the specified user's group. If the specified user is part of a service provider, the directory includes all users in the user's group and all entries in the common phone list of the specified user's group. It is possible to search the directory for names containing a specified search string. The search includes matches on first name or last name or common phone list names. The response is either UserPhoneDirectoryGetSearchedListResponse 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 @Size(min=1) String	nameSearchString
protected @NotNull @Valid BroadWorksUser	user

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

log

Constructor Summary

Constructors

Constructor	Description
UserPhoneDirectoryGetSearchedListRequest()
UserPhoneDirectoryGetSearchedListRequest(BroadWorksUser user)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
BroadWorksUser	getBroadWorksUser()
static User.UserPhoneDirectoryGetSearchedListRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
String	getNameSearchString()
User.UserPhoneDirectoryGetSearchedListRequest	setNameSearchString(String nameSearchString)
User.UserPhoneDirectoryGetSearchedListRequest	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

nameSearchString

@Size(min=1)
protected @Size(min=1) String nameSearchString

Constructor Details

UserPhoneDirectoryGetSearchedListRequest

public UserPhoneDirectoryGetSearchedListRequest()

UserPhoneDirectoryGetSearchedListRequest

public UserPhoneDirectoryGetSearchedListRequest(BroadWorksUser user)

Method Details

setUser

public User.UserPhoneDirectoryGetSearchedListRequest setUser(BroadWorksUser user)

getBroadWorksUser

public BroadWorksUser getBroadWorksUser()

setNameSearchString

public User.UserPhoneDirectoryGetSearchedListRequest setNameSearchString(String nameSearchString)

getNameSearchString

public String getNameSearchString()

getEmptyObject

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