co.ecg.alpaca.toolkit.generated

Class User.UserGetListInSystemRequest

java.lang.Object

co.ecg.alpaca.toolkit.Request<User.UserGetListInSystemResponse>

co.ecg.alpaca.toolkit.generated.User.UserGetListInSystemRequest

All Implemented Interfaces:

Runnable

Enclosing class:

User

public static class User.UserGetListInSystemRequest
extends Request<User.UserGetListInSystemResponse>

Request the list of users in the system. It is possible to search by various criteria to restrict the number of rows returned. Multiple search criteria are logically ANDed together. The response is either a UserGetListInSystemResponse or an ErrorResponse.

Field Summary

Fields

Modifier and Type	Field and Description
Integer	responseSizeLimit
boolean	responseSizeLimitIsModified
SearchCriteriaDn[]	searchCriteriaDn
boolean	searchCriteriaDnIsModified
SearchCriteriaEmailAddress[]	searchCriteriaEmailAddress
boolean	searchCriteriaEmailAddressIsModified
SearchCriteriaExactServiceProvider	searchCriteriaExactServiceProvider
boolean	searchCriteriaExactServiceProviderIsModified
SearchCriteriaExactUserInTrunkGroup	searchCriteriaExactUserInTrunkGroup
boolean	searchCriteriaExactUserInTrunkGroupIsModified
SearchCriteriaExactUserNetworkClassOfService	searchCriteriaExactUserNetworkClassOfService
boolean	searchCriteriaExactUserNetworkClassOfServiceIsModified
SearchCriteriaExtension[]	searchCriteriaExtension
boolean	searchCriteriaExtensionIsModified
SearchCriteriaGroupId[]	searchCriteriaGroupId
boolean	searchCriteriaGroupIdIsModified
SearchCriteriaUserFirstName[]	searchCriteriaUserFirstName
boolean	searchCriteriaUserFirstNameIsModified
SearchCriteriaUserId[]	searchCriteriaUserId
boolean	searchCriteriaUserIdIsModified
SearchCriteriaUserLastName[]	searchCriteriaUserLastName
boolean	searchCriteriaUserLastNameIsModified

Constructor Summary

Constructors

Constructor and Description
UserGetListInSystemRequest(BroadWorksServer bws)

Method Summary

Modifier and Type	Method and Description
void	formRequest() Forms the XML Document for this Request Object.
Integer	getResponseSizeLimit()
SearchCriteriaDn[]	getSearchCriteriaDn()
SearchCriteriaEmailAddress[]	getSearchCriteriaEmailAddress()
SearchCriteriaExactServiceProvider	getSearchCriteriaExactServiceProvider()
SearchCriteriaExactUserInTrunkGroup	getSearchCriteriaExactUserInTrunkGroup()
SearchCriteriaExactUserNetworkClassOfService	getSearchCriteriaExactUserNetworkClassOfService()
SearchCriteriaExtension[]	getSearchCriteriaExtension()
SearchCriteriaGroupId[]	getSearchCriteriaGroupId()
SearchCriteriaUserFirstName[]	getSearchCriteriaUserFirstName()
SearchCriteriaUserId[]	getSearchCriteriaUserId()
SearchCriteriaUserLastName[]	getSearchCriteriaUserLastName()
User.UserGetListInSystemRequest	setResponseSizeLimit(Integer responseSizeLimit)
User.UserGetListInSystemRequest	setSearchCriteriaDn(SearchCriteriaDn... searchCriteriaDn)
User.UserGetListInSystemRequest	setSearchCriteriaEmailAddress(SearchCriteriaEmailAddress... searchCriteriaEmailAddress)
User.UserGetListInSystemRequest	setSearchCriteriaExactServiceProvider(SearchCriteriaExactServiceProvider searchCriteriaExactServiceProvider)
User.UserGetListInSystemRequest	setSearchCriteriaExactUserInTrunkGroup(SearchCriteriaExactUserInTrunkGroup searchCriteriaExactUserInTrunkGroup)
User.UserGetListInSystemRequest	setSearchCriteriaExactUserNetworkClassOfService(SearchCriteriaExactUserNetworkClassOfService searchCriteriaExactUserNetworkClassOfService)
User.UserGetListInSystemRequest	setSearchCriteriaExtension(SearchCriteriaExtension... searchCriteriaExtension)
User.UserGetListInSystemRequest	setSearchCriteriaGroupId(SearchCriteriaGroupId... searchCriteriaGroupId)
User.UserGetListInSystemRequest	setSearchCriteriaUserFirstName(SearchCriteriaUserFirstName... searchCriteriaUserFirstName)
User.UserGetListInSystemRequest	setSearchCriteriaUserId(SearchCriteriaUserId... searchCriteriaUserId)
User.UserGetListInSystemRequest	setSearchCriteriaUserLastName(SearchCriteriaUserLastName... searchCriteriaUserLastName)

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

appendChild, appendChild, appendChild, asyncFire, createElement, createNilElement, createTextElement, fire, fire, getBroadWorksServer, getCommandType, getDomDocument, getResponseClass, 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

responseSizeLimit

public Integer responseSizeLimit

responseSizeLimitIsModified

public transient boolean responseSizeLimitIsModified

searchCriteriaUserLastName

public SearchCriteriaUserLastName[] searchCriteriaUserLastName

searchCriteriaUserLastNameIsModified

public transient boolean searchCriteriaUserLastNameIsModified

searchCriteriaUserFirstName

public SearchCriteriaUserFirstName[] searchCriteriaUserFirstName

searchCriteriaUserFirstNameIsModified

public transient boolean searchCriteriaUserFirstNameIsModified

searchCriteriaDn

public SearchCriteriaDn[] searchCriteriaDn

searchCriteriaDnIsModified

public transient boolean searchCriteriaDnIsModified

searchCriteriaEmailAddress

public SearchCriteriaEmailAddress[] searchCriteriaEmailAddress

searchCriteriaEmailAddressIsModified

public transient boolean searchCriteriaEmailAddressIsModified

searchCriteriaGroupId

public SearchCriteriaGroupId[] searchCriteriaGroupId

searchCriteriaGroupIdIsModified

public transient boolean searchCriteriaGroupIdIsModified

searchCriteriaExactServiceProvider

public SearchCriteriaExactServiceProvider searchCriteriaExactServiceProvider

searchCriteriaExactServiceProviderIsModified

public transient boolean searchCriteriaExactServiceProviderIsModified

searchCriteriaExactUserInTrunkGroup

public SearchCriteriaExactUserInTrunkGroup searchCriteriaExactUserInTrunkGroup

searchCriteriaExactUserInTrunkGroupIsModified

public transient boolean searchCriteriaExactUserInTrunkGroupIsModified

searchCriteriaExactUserNetworkClassOfService

public SearchCriteriaExactUserNetworkClassOfService searchCriteriaExactUserNetworkClassOfService

searchCriteriaExactUserNetworkClassOfServiceIsModified

public transient boolean searchCriteriaExactUserNetworkClassOfServiceIsModified

searchCriteriaUserId

public SearchCriteriaUserId[] searchCriteriaUserId

searchCriteriaUserIdIsModified

public transient boolean searchCriteriaUserIdIsModified

searchCriteriaExtension

public SearchCriteriaExtension[] searchCriteriaExtension

searchCriteriaExtensionIsModified

public transient boolean searchCriteriaExtensionIsModified

Constructor Detail

UserGetListInSystemRequest

public UserGetListInSystemRequest(BroadWorksServer bws)

Method Detail

setResponseSizeLimit

public User.UserGetListInSystemRequest setResponseSizeLimit(Integer responseSizeLimit)

getResponseSizeLimit

public Integer getResponseSizeLimit()

setSearchCriteriaUserLastName

public User.UserGetListInSystemRequest setSearchCriteriaUserLastName(SearchCriteriaUserLastName... searchCriteriaUserLastName)

getSearchCriteriaUserLastName

public SearchCriteriaUserLastName[] getSearchCriteriaUserLastName()

setSearchCriteriaUserFirstName

public User.UserGetListInSystemRequest setSearchCriteriaUserFirstName(SearchCriteriaUserFirstName... searchCriteriaUserFirstName)

getSearchCriteriaUserFirstName

public SearchCriteriaUserFirstName[] getSearchCriteriaUserFirstName()

setSearchCriteriaDn

public User.UserGetListInSystemRequest setSearchCriteriaDn(SearchCriteriaDn... searchCriteriaDn)

getSearchCriteriaDn

public SearchCriteriaDn[] getSearchCriteriaDn()

setSearchCriteriaEmailAddress

public User.UserGetListInSystemRequest setSearchCriteriaEmailAddress(SearchCriteriaEmailAddress... searchCriteriaEmailAddress)

getSearchCriteriaEmailAddress

public SearchCriteriaEmailAddress[] getSearchCriteriaEmailAddress()

setSearchCriteriaGroupId

public User.UserGetListInSystemRequest setSearchCriteriaGroupId(SearchCriteriaGroupId... searchCriteriaGroupId)

getSearchCriteriaGroupId

public SearchCriteriaGroupId[] getSearchCriteriaGroupId()

setSearchCriteriaExactServiceProvider

public User.UserGetListInSystemRequest setSearchCriteriaExactServiceProvider(SearchCriteriaExactServiceProvider searchCriteriaExactServiceProvider)

getSearchCriteriaExactServiceProvider

public SearchCriteriaExactServiceProvider getSearchCriteriaExactServiceProvider()

setSearchCriteriaExactUserInTrunkGroup

public User.UserGetListInSystemRequest setSearchCriteriaExactUserInTrunkGroup(SearchCriteriaExactUserInTrunkGroup searchCriteriaExactUserInTrunkGroup)

getSearchCriteriaExactUserInTrunkGroup

public SearchCriteriaExactUserInTrunkGroup getSearchCriteriaExactUserInTrunkGroup()

setSearchCriteriaExactUserNetworkClassOfService

public User.UserGetListInSystemRequest setSearchCriteriaExactUserNetworkClassOfService(SearchCriteriaExactUserNetworkClassOfService searchCriteriaExactUserNetworkClassOfService)

getSearchCriteriaExactUserNetworkClassOfService

public SearchCriteriaExactUserNetworkClassOfService getSearchCriteriaExactUserNetworkClassOfService()

setSearchCriteriaUserId

public User.UserGetListInSystemRequest setSearchCriteriaUserId(SearchCriteriaUserId... searchCriteriaUserId)

getSearchCriteriaUserId

public SearchCriteriaUserId[] getSearchCriteriaUserId()

setSearchCriteriaExtension

public User.UserGetListInSystemRequest setSearchCriteriaExtension(SearchCriteriaExtension... searchCriteriaExtension)

getSearchCriteriaExtension

public SearchCriteriaExtension[] getSearchCriteriaExtension()

formRequest

public void formRequest()
                 throws RequestException

Forms the XML Document for this Request Object. Called by the Request upon fire().

Specified by:

formRequest in class Request<User.UserGetListInSystemResponse>

Throws:

RequestException