Package co.ecg.alpaca.toolkit.generated.services

Class UserReceptionistEnterprise.UserBroadWorksReceptionistEnterpriseGetAvailableUserListRequest

java.lang.Object

co.ecg.alpaca.toolkit.messaging.request.Request<UserReceptionistEnterprise.UserBroadWorksReceptionistEnterpriseGetAvailableUserListResponse>

co.ecg.alpaca.toolkit.generated.services.UserReceptionistEnterprise.UserBroadWorksReceptionistEnterpriseGetAvailableUserListRequest

Enclosing class:

UserReceptionistEnterprise

public static class UserReceptionistEnterprise.UserBroadWorksReceptionistEnterpriseGetAvailableUserListRequest
extends Request<UserReceptionistEnterprise.UserBroadWorksReceptionistEnterpriseGetAvailableUserListResponse>

Get a list of available users for BroadWorks Receptionist - Enterprise monitoring. The response is either UserBroadWorksReceptionistEnterpriseGetAvailableUserListResponse or ErrorResponse. The Receptionist Note column is only populated, if the user sending the request is the owner of the Receptionist Note and a Note exists.

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 Integer	responseSizeLimit
protected @Valid SearchCriteriaDn[]	searchCriteriaDn
protected @Valid SearchCriteriaExactUserDepartment	searchCriteriaExactUserDepartment
protected @Valid SearchCriteriaExactUserGroup	searchCriteriaExactUserGroup
protected @Valid SearchCriteriaExtension[]	searchCriteriaExtension
protected @Valid SearchCriteriaImpId[]	searchCriteriaImpId
protected @Valid SearchCriteriaReceptionistNote[]	searchCriteriaReceptionistNote
protected @Valid SearchCriteriaUserFirstName[]	searchCriteriaUserFirstName
protected @Valid SearchCriteriaUserId[]	searchCriteriaUserId
protected @Valid SearchCriteriaUserLastName[]	searchCriteriaUserLastName
protected @NotNull @Valid BroadWorksUser	user

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

log

Constructor Summary

Constructors

Constructor	Description
UserBroadWorksReceptionistEnterpriseGetAvailableUserListRequest()
UserBroadWorksReceptionistEnterpriseGetAvailableUserListRequest(BroadWorksUser user)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
BroadWorksUser	getBroadWorksUser()
static UserReceptionistEnterprise.UserBroadWorksReceptionistEnterpriseGetAvailableUserListRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
Integer	getResponseSizeLimit()
SearchCriteriaDn[]	getSearchCriteriaDn()
SearchCriteriaExactUserDepartment	getSearchCriteriaExactUserDepartment()
SearchCriteriaExactUserGroup	getSearchCriteriaExactUserGroup()
SearchCriteriaExtension[]	getSearchCriteriaExtension()
SearchCriteriaImpId[]	getSearchCriteriaImpId()
SearchCriteriaReceptionistNote[]	getSearchCriteriaReceptionistNote()
SearchCriteriaUserFirstName[]	getSearchCriteriaUserFirstName()
SearchCriteriaUserId[]	getSearchCriteriaUserId()
SearchCriteriaUserLastName[]	getSearchCriteriaUserLastName()
UserReceptionistEnterprise.UserBroadWorksReceptionistEnterpriseGetAvailableUserListRequest	setResponseSizeLimit(Integer responseSizeLimit)
UserReceptionistEnterprise.UserBroadWorksReceptionistEnterpriseGetAvailableUserListRequest	setSearchCriteriaDn(SearchCriteriaDn... searchCriteriaDn)
UserReceptionistEnterprise.UserBroadWorksReceptionistEnterpriseGetAvailableUserListRequest	setSearchCriteriaExactUserDepartment(SearchCriteriaExactUserDepartment searchCriteriaExactUserDepartment)
UserReceptionistEnterprise.UserBroadWorksReceptionistEnterpriseGetAvailableUserListRequest	setSearchCriteriaExactUserGroup(SearchCriteriaExactUserGroup searchCriteriaExactUserGroup)
UserReceptionistEnterprise.UserBroadWorksReceptionistEnterpriseGetAvailableUserListRequest	setSearchCriteriaExtension(SearchCriteriaExtension... searchCriteriaExtension)
UserReceptionistEnterprise.UserBroadWorksReceptionistEnterpriseGetAvailableUserListRequest	setSearchCriteriaImpId(SearchCriteriaImpId... searchCriteriaImpId)
UserReceptionistEnterprise.UserBroadWorksReceptionistEnterpriseGetAvailableUserListRequest	setSearchCriteriaReceptionistNote(SearchCriteriaReceptionistNote... searchCriteriaReceptionistNote)
UserReceptionistEnterprise.UserBroadWorksReceptionistEnterpriseGetAvailableUserListRequest	setSearchCriteriaUserFirstName(SearchCriteriaUserFirstName... searchCriteriaUserFirstName)
UserReceptionistEnterprise.UserBroadWorksReceptionistEnterpriseGetAvailableUserListRequest	setSearchCriteriaUserId(SearchCriteriaUserId... searchCriteriaUserId)
UserReceptionistEnterprise.UserBroadWorksReceptionistEnterpriseGetAvailableUserListRequest	setSearchCriteriaUserLastName(SearchCriteriaUserLastName... searchCriteriaUserLastName)
UserReceptionistEnterprise.UserBroadWorksReceptionistEnterpriseGetAvailableUserListRequest	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

responseSizeLimit

protected Integer responseSizeLimit

searchCriteriaUserLastName

@Valid
protected @Valid SearchCriteriaUserLastName[] searchCriteriaUserLastName

searchCriteriaUserFirstName

@Valid
protected @Valid SearchCriteriaUserFirstName[] searchCriteriaUserFirstName

searchCriteriaExactUserDepartment

@Valid
protected @Valid SearchCriteriaExactUserDepartment searchCriteriaExactUserDepartment

searchCriteriaExactUserGroup

@Valid
protected @Valid SearchCriteriaExactUserGroup searchCriteriaExactUserGroup

searchCriteriaUserId

@Valid
protected @Valid SearchCriteriaUserId[] searchCriteriaUserId

searchCriteriaDn

@Valid
protected @Valid SearchCriteriaDn[] searchCriteriaDn

searchCriteriaExtension

@Valid
protected @Valid SearchCriteriaExtension[] searchCriteriaExtension

searchCriteriaImpId

@Valid
protected @Valid SearchCriteriaImpId[] searchCriteriaImpId

searchCriteriaReceptionistNote

@Valid
protected @Valid SearchCriteriaReceptionistNote[] searchCriteriaReceptionistNote

Constructor Details

UserBroadWorksReceptionistEnterpriseGetAvailableUserListRequest

public UserBroadWorksReceptionistEnterpriseGetAvailableUserListRequest()

UserBroadWorksReceptionistEnterpriseGetAvailableUserListRequest

public UserBroadWorksReceptionistEnterpriseGetAvailableUserListRequest(BroadWorksUser user)

Method Details

setUser

public UserReceptionistEnterprise.UserBroadWorksReceptionistEnterpriseGetAvailableUserListRequest setUser(BroadWorksUser user)

getBroadWorksUser

public BroadWorksUser getBroadWorksUser()

setResponseSizeLimit

public UserReceptionistEnterprise.UserBroadWorksReceptionistEnterpriseGetAvailableUserListRequest setResponseSizeLimit(Integer responseSizeLimit)

getResponseSizeLimit

public Integer getResponseSizeLimit()

setSearchCriteriaUserLastName

public UserReceptionistEnterprise.UserBroadWorksReceptionistEnterpriseGetAvailableUserListRequest setSearchCriteriaUserLastName(SearchCriteriaUserLastName... searchCriteriaUserLastName)

getSearchCriteriaUserLastName

public SearchCriteriaUserLastName[] getSearchCriteriaUserLastName()

setSearchCriteriaUserFirstName

public UserReceptionistEnterprise.UserBroadWorksReceptionistEnterpriseGetAvailableUserListRequest setSearchCriteriaUserFirstName(SearchCriteriaUserFirstName... searchCriteriaUserFirstName)

getSearchCriteriaUserFirstName

public SearchCriteriaUserFirstName[] getSearchCriteriaUserFirstName()

setSearchCriteriaExactUserDepartment

public UserReceptionistEnterprise.UserBroadWorksReceptionistEnterpriseGetAvailableUserListRequest setSearchCriteriaExactUserDepartment(SearchCriteriaExactUserDepartment searchCriteriaExactUserDepartment)

getSearchCriteriaExactUserDepartment

public SearchCriteriaExactUserDepartment getSearchCriteriaExactUserDepartment()

setSearchCriteriaExactUserGroup

public UserReceptionistEnterprise.UserBroadWorksReceptionistEnterpriseGetAvailableUserListRequest setSearchCriteriaExactUserGroup(SearchCriteriaExactUserGroup searchCriteriaExactUserGroup)

getSearchCriteriaExactUserGroup

public SearchCriteriaExactUserGroup getSearchCriteriaExactUserGroup()

setSearchCriteriaUserId

public UserReceptionistEnterprise.UserBroadWorksReceptionistEnterpriseGetAvailableUserListRequest setSearchCriteriaUserId(SearchCriteriaUserId... searchCriteriaUserId)

getSearchCriteriaUserId

public SearchCriteriaUserId[] getSearchCriteriaUserId()

setSearchCriteriaDn

public UserReceptionistEnterprise.UserBroadWorksReceptionistEnterpriseGetAvailableUserListRequest setSearchCriteriaDn(SearchCriteriaDn... searchCriteriaDn)

getSearchCriteriaDn

public SearchCriteriaDn[] getSearchCriteriaDn()

setSearchCriteriaExtension

public UserReceptionistEnterprise.UserBroadWorksReceptionistEnterpriseGetAvailableUserListRequest setSearchCriteriaExtension(SearchCriteriaExtension... searchCriteriaExtension)

getSearchCriteriaExtension

public SearchCriteriaExtension[] getSearchCriteriaExtension()

setSearchCriteriaImpId

public UserReceptionistEnterprise.UserBroadWorksReceptionistEnterpriseGetAvailableUserListRequest setSearchCriteriaImpId(SearchCriteriaImpId... searchCriteriaImpId)

getSearchCriteriaImpId

public SearchCriteriaImpId[] getSearchCriteriaImpId()

setSearchCriteriaReceptionistNote

public UserReceptionistEnterprise.UserBroadWorksReceptionistEnterpriseGetAvailableUserListRequest setSearchCriteriaReceptionistNote(SearchCriteriaReceptionistNote... searchCriteriaReceptionistNote)

getSearchCriteriaReceptionistNote

public SearchCriteriaReceptionistNote[] getSearchCriteriaReceptionistNote()

getEmptyObject

public static UserReceptionistEnterprise.UserBroadWorksReceptionistEnterpriseGetAvailableUserListRequest 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<UserReceptionistEnterprise.UserBroadWorksReceptionistEnterpriseGetAvailableUserListResponse>