Package co.ecg.alpaca.toolkit.generated

Class GroupPaging.GroupGroupPagingGetAvailableTargetListRequest

java.lang.Object

co.ecg.alpaca.toolkit.messaging.request.Request<GroupPaging.GroupGroupPagingGetAvailableTargetListResponse>

co.ecg.alpaca.toolkit.generated.GroupPaging.GroupGroupPagingGetAvailableTargetListRequest

Enclosing class:

GroupPaging

public static class GroupPaging.GroupGroupPagingGetAvailableTargetListRequest
extends Request<GroupPaging.GroupGroupPagingGetAvailableTargetListResponse>

Get a list of users that can be assigned as targets to a given paging group. Searching for users by group only makes sense when the paging group is part of an Enterprise. The response is either GroupGroupPagingGetAvailableTargetListResponse 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 Integer	responseSizeLimit
protected @Valid SearchCriteriaDn[]	searchCriteriaDn
protected @Valid SearchCriteriaExactUserDepartment	searchCriteriaExactUserDepartment
protected @Valid SearchCriteriaExactUserGroup	searchCriteriaExactUserGroup
protected @Valid SearchCriteriaExtension[]	searchCriteriaExtension
protected @Valid SearchCriteriaUserFirstName[]	searchCriteriaUserFirstName
protected @Valid SearchCriteriaUserId[]	searchCriteriaUserId
protected @Valid SearchCriteriaUserLastName[]	searchCriteriaUserLastName
protected @NotNull @Valid GroupPaging	user

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

log

Constructor Summary

Constructors

Constructor	Description
GroupGroupPagingGetAvailableTargetListRequest()
GroupGroupPagingGetAvailableTargetListRequest(GroupPaging user)

Method Summary

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

Constructor Details

GroupGroupPagingGetAvailableTargetListRequest

public GroupGroupPagingGetAvailableTargetListRequest()

GroupGroupPagingGetAvailableTargetListRequest

public GroupGroupPagingGetAvailableTargetListRequest(GroupPaging user)

Method Details

setUser

public GroupPaging.GroupGroupPagingGetAvailableTargetListRequest setUser(GroupPaging user)

getGroupPaging

public GroupPaging getGroupPaging()

setResponseSizeLimit

public GroupPaging.GroupGroupPagingGetAvailableTargetListRequest setResponseSizeLimit(Integer responseSizeLimit)

getResponseSizeLimit

public Integer getResponseSizeLimit()

setSearchCriteriaUserLastName

public GroupPaging.GroupGroupPagingGetAvailableTargetListRequest setSearchCriteriaUserLastName(SearchCriteriaUserLastName... searchCriteriaUserLastName)

getSearchCriteriaUserLastName

public SearchCriteriaUserLastName[] getSearchCriteriaUserLastName()

setSearchCriteriaUserFirstName

public GroupPaging.GroupGroupPagingGetAvailableTargetListRequest setSearchCriteriaUserFirstName(SearchCriteriaUserFirstName... searchCriteriaUserFirstName)

getSearchCriteriaUserFirstName

public SearchCriteriaUserFirstName[] getSearchCriteriaUserFirstName()

setSearchCriteriaExactUserDepartment

public GroupPaging.GroupGroupPagingGetAvailableTargetListRequest setSearchCriteriaExactUserDepartment(SearchCriteriaExactUserDepartment searchCriteriaExactUserDepartment)

getSearchCriteriaExactUserDepartment

public SearchCriteriaExactUserDepartment getSearchCriteriaExactUserDepartment()

setSearchCriteriaExactUserGroup

public GroupPaging.GroupGroupPagingGetAvailableTargetListRequest setSearchCriteriaExactUserGroup(SearchCriteriaExactUserGroup searchCriteriaExactUserGroup)

getSearchCriteriaExactUserGroup

public SearchCriteriaExactUserGroup getSearchCriteriaExactUserGroup()

setSearchCriteriaUserId

public GroupPaging.GroupGroupPagingGetAvailableTargetListRequest setSearchCriteriaUserId(SearchCriteriaUserId... searchCriteriaUserId)

getSearchCriteriaUserId

public SearchCriteriaUserId[] getSearchCriteriaUserId()

setSearchCriteriaDn

public GroupPaging.GroupGroupPagingGetAvailableTargetListRequest setSearchCriteriaDn(SearchCriteriaDn... searchCriteriaDn)

getSearchCriteriaDn

public SearchCriteriaDn[] getSearchCriteriaDn()

setSearchCriteriaExtension

public GroupPaging.GroupGroupPagingGetAvailableTargetListRequest setSearchCriteriaExtension(SearchCriteriaExtension... searchCriteriaExtension)

getSearchCriteriaExtension

public SearchCriteriaExtension[] getSearchCriteriaExtension()

getEmptyObject

public static GroupPaging.GroupGroupPagingGetAvailableTargetListRequest 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<GroupPaging.GroupGroupPagingGetAvailableTargetListResponse>