co.ecg.alpaca.toolkit.generated.services

Class GroupPaging.GroupGroupPagingGetAvailableTargetListRequest

java.lang.Object

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

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

All Implemented Interfaces:

Runnable

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.

Field Summary

Fields

Modifier and Type	Field and Description
Integer	responseSizeLimit
boolean	responseSizeLimitIsModified
SearchCriteriaDn[]	searchCriteriaDn
boolean	searchCriteriaDnIsModified
SearchCriteriaExactUserDepartment	searchCriteriaExactUserDepartment
boolean	searchCriteriaExactUserDepartmentIsModified
SearchCriteriaExactUserGroup	searchCriteriaExactUserGroup
boolean	searchCriteriaExactUserGroupIsModified
SearchCriteriaExtension[]	searchCriteriaExtension
boolean	searchCriteriaExtensionIsModified
SearchCriteriaUserFirstName[]	searchCriteriaUserFirstName
boolean	searchCriteriaUserFirstNameIsModified
SearchCriteriaUserId[]	searchCriteriaUserId
boolean	searchCriteriaUserIdIsModified
SearchCriteriaUserLastName[]	searchCriteriaUserLastName
boolean	searchCriteriaUserLastNameIsModified
String	serviceUserId
boolean	serviceUserIdIsModified

Constructor Summary

Constructors

Constructor and Description
GroupGroupPagingGetAvailableTargetListRequest(BroadWorksServer bws) Default Constructor -- Not Guaranteed to work without checking Request validity with isValid()
GroupGroupPagingGetAvailableTargetListRequest(BroadWorksServer bws, String serviceUserId)

Method Summary

Modifier and Type	Method and Description
void	formRequest() Forms the XML Document for this Request Object.
Integer	getResponseSizeLimit()
SearchCriteriaDn[]	getSearchCriteriaDn()
SearchCriteriaExactUserDepartment	getSearchCriteriaExactUserDepartment()
SearchCriteriaExactUserGroup	getSearchCriteriaExactUserGroup()
SearchCriteriaExtension[]	getSearchCriteriaExtension()
SearchCriteriaUserFirstName[]	getSearchCriteriaUserFirstName()
SearchCriteriaUserId[]	getSearchCriteriaUserId()
SearchCriteriaUserLastName[]	getSearchCriteriaUserLastName()
String	getServiceUserId()
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	setServiceUserId(String serviceUserId)

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

serviceUserId

@Size(min=1,
      max=161)
public String serviceUserId

serviceUserIdIsModified

public transient boolean serviceUserIdIsModified

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

searchCriteriaExactUserDepartment

public SearchCriteriaExactUserDepartment searchCriteriaExactUserDepartment

searchCriteriaExactUserDepartmentIsModified

public transient boolean searchCriteriaExactUserDepartmentIsModified

searchCriteriaExactUserGroup

public SearchCriteriaExactUserGroup searchCriteriaExactUserGroup

searchCriteriaExactUserGroupIsModified

public transient boolean searchCriteriaExactUserGroupIsModified

searchCriteriaUserId

public SearchCriteriaUserId[] searchCriteriaUserId

searchCriteriaUserIdIsModified

public transient boolean searchCriteriaUserIdIsModified

searchCriteriaDn

public SearchCriteriaDn[] searchCriteriaDn

searchCriteriaDnIsModified

public transient boolean searchCriteriaDnIsModified

searchCriteriaExtension

public SearchCriteriaExtension[] searchCriteriaExtension

searchCriteriaExtensionIsModified

public transient boolean searchCriteriaExtensionIsModified

Constructor Detail

GroupGroupPagingGetAvailableTargetListRequest

public GroupGroupPagingGetAvailableTargetListRequest(BroadWorksServer bws,
                                                     String serviceUserId)

GroupGroupPagingGetAvailableTargetListRequest

public GroupGroupPagingGetAvailableTargetListRequest(BroadWorksServer bws)

Default Constructor -- Not Guaranteed to work without checking Request validity with isValid()

Parameters:

bws - The BroadWorksServer to use for the Request

Method Detail

setServiceUserId

public GroupPaging.GroupGroupPagingGetAvailableTargetListRequest setServiceUserId(String serviceUserId)

getServiceUserId

public String getServiceUserId()

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()

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<GroupPaging.GroupGroupPagingGetAvailableTargetListResponse>

Throws:

RequestException