co.ecg.alpaca.toolkit.generated

Class User.UserGetListInGroupRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.User.UserGetListInGroupRequest

Enclosing class:

User

@GwtIncompatible
public static class User.UserGetListInGroupRequest
extends Request<User.UserGetListInGroupResponse>

Request the list of users in a group. 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 UserGetListInGroupResponse or an 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 and Description
protected String	groupId
protected Integer	responseSizeLimit
protected SearchCriteriaDn[]	searchCriteriaDn
protected SearchCriteriaEmailAddress[]	searchCriteriaEmailAddress
protected SearchCriteriaExactUserDepartment	searchCriteriaExactUserDepartment
protected SearchCriteriaExactUserInTrunkGroup	searchCriteriaExactUserInTrunkGroup
protected SearchCriteriaExtension[]	searchCriteriaExtension
protected SearchCriteriaUserFirstName[]	searchCriteriaUserFirstName
protected SearchCriteriaUserId[]	searchCriteriaUserId
protected SearchCriteriaUserLastName[]	searchCriteriaUserLastName
protected ServiceProvider	serviceProvider

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

log

Constructor Summary

Constructors

Constructor and Description
UserGetListInGroupRequest(ServiceProvider serviceProvider, String groupId)

Method Summary

Modifier and Type	Method and Description
void	formRequest() Forms the XML Document for this Request Object.
static User.UserGetListInGroupRequest	getEmptyObject(BroadWorksServer broadWorksServer) Retrieves this object with minimal setup.
String	getGroupId()
Integer	getResponseSizeLimit()
SearchCriteriaDn[]	getSearchCriteriaDn()
SearchCriteriaEmailAddress[]	getSearchCriteriaEmailAddress()
SearchCriteriaExactUserDepartment	getSearchCriteriaExactUserDepartment()
SearchCriteriaExactUserInTrunkGroup	getSearchCriteriaExactUserInTrunkGroup()
SearchCriteriaExtension[]	getSearchCriteriaExtension()
SearchCriteriaUserFirstName[]	getSearchCriteriaUserFirstName()
SearchCriteriaUserId[]	getSearchCriteriaUserId()
SearchCriteriaUserLastName[]	getSearchCriteriaUserLastName()
ServiceProvider	getServiceProvider()
User.UserGetListInGroupRequest	setGroupId(String groupId)
User.UserGetListInGroupRequest	setResponseSizeLimit(Integer responseSizeLimit)
User.UserGetListInGroupRequest	setSearchCriteriaDn(SearchCriteriaDn... searchCriteriaDn)
User.UserGetListInGroupRequest	setSearchCriteriaEmailAddress(SearchCriteriaEmailAddress... searchCriteriaEmailAddress)
User.UserGetListInGroupRequest	setSearchCriteriaExactUserDepartment(SearchCriteriaExactUserDepartment searchCriteriaExactUserDepartment)
User.UserGetListInGroupRequest	setSearchCriteriaExactUserInTrunkGroup(SearchCriteriaExactUserInTrunkGroup searchCriteriaExactUserInTrunkGroup)
User.UserGetListInGroupRequest	setSearchCriteriaExtension(SearchCriteriaExtension... searchCriteriaExtension)
User.UserGetListInGroupRequest	setSearchCriteriaUserFirstName(SearchCriteriaUserFirstName... searchCriteriaUserFirstName)
User.UserGetListInGroupRequest	setSearchCriteriaUserId(SearchCriteriaUserId... searchCriteriaUserId)
User.UserGetListInGroupRequest	setSearchCriteriaUserLastName(SearchCriteriaUserLastName... searchCriteriaUserLastName)
User.UserGetListInGroupRequest	setServiceProvider(ServiceProvider serviceProvider)

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

appendChild, appendChild, appendChild, asyncFire, createElement, createNilElement, createTextElement, fire, fire, getBroadWorksServer, getCacheString, getCommandElement, getCommandType, getDomDocument, getId, getResponseClass, getRootElement, getValidationErrorsAsString, isMemberOfBundle, isValid, 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

serviceProvider

@NotNull
protected transient ServiceProvider serviceProvider

groupId

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

responseSizeLimit

protected Integer responseSizeLimit

searchCriteriaUserLastName

protected SearchCriteriaUserLastName[] searchCriteriaUserLastName

searchCriteriaUserFirstName

protected SearchCriteriaUserFirstName[] searchCriteriaUserFirstName

searchCriteriaDn

protected SearchCriteriaDn[] searchCriteriaDn

searchCriteriaEmailAddress

protected SearchCriteriaEmailAddress[] searchCriteriaEmailAddress

searchCriteriaExactUserDepartment

protected SearchCriteriaExactUserDepartment searchCriteriaExactUserDepartment

searchCriteriaExactUserInTrunkGroup

protected SearchCriteriaExactUserInTrunkGroup searchCriteriaExactUserInTrunkGroup

searchCriteriaUserId

protected SearchCriteriaUserId[] searchCriteriaUserId

searchCriteriaExtension

protected SearchCriteriaExtension[] searchCriteriaExtension

Constructor Detail

UserGetListInGroupRequest

public UserGetListInGroupRequest(ServiceProvider serviceProvider,
                                 String groupId)

Method Detail

setServiceProvider

public User.UserGetListInGroupRequest setServiceProvider(ServiceProvider serviceProvider)

getServiceProvider

public ServiceProvider getServiceProvider()

setGroupId

public User.UserGetListInGroupRequest setGroupId(String groupId)

getGroupId

public String getGroupId()

setResponseSizeLimit

public User.UserGetListInGroupRequest setResponseSizeLimit(Integer responseSizeLimit)

getResponseSizeLimit

public Integer getResponseSizeLimit()

setSearchCriteriaUserLastName

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

getSearchCriteriaUserLastName

public SearchCriteriaUserLastName[] getSearchCriteriaUserLastName()

setSearchCriteriaUserFirstName

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

getSearchCriteriaUserFirstName

public SearchCriteriaUserFirstName[] getSearchCriteriaUserFirstName()

setSearchCriteriaDn

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

getSearchCriteriaDn

public SearchCriteriaDn[] getSearchCriteriaDn()

setSearchCriteriaEmailAddress

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

getSearchCriteriaEmailAddress

public SearchCriteriaEmailAddress[] getSearchCriteriaEmailAddress()

setSearchCriteriaExactUserDepartment

public User.UserGetListInGroupRequest setSearchCriteriaExactUserDepartment(SearchCriteriaExactUserDepartment searchCriteriaExactUserDepartment)

getSearchCriteriaExactUserDepartment

public SearchCriteriaExactUserDepartment getSearchCriteriaExactUserDepartment()

setSearchCriteriaExactUserInTrunkGroup

public User.UserGetListInGroupRequest setSearchCriteriaExactUserInTrunkGroup(SearchCriteriaExactUserInTrunkGroup searchCriteriaExactUserInTrunkGroup)

getSearchCriteriaExactUserInTrunkGroup

public SearchCriteriaExactUserInTrunkGroup getSearchCriteriaExactUserInTrunkGroup()

setSearchCriteriaUserId

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

getSearchCriteriaUserId

public SearchCriteriaUserId[] getSearchCriteriaUserId()

setSearchCriteriaExtension

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

getSearchCriteriaExtension

public SearchCriteriaExtension[] getSearchCriteriaExtension()

getEmptyObject

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