Package co.ecg.alpaca.toolkit.generated

Class CollaborateBridge.GroupCollaborateBridgeGetAvailableUserListRequest

java.lang.Object

co.ecg.alpaca.toolkit.messaging.request.Request<CollaborateBridge.GroupCollaborateBridgeGetAvailableUserListResponse>

co.ecg.alpaca.toolkit.generated.CollaborateBridge.GroupCollaborateBridgeGetAvailableUserListRequest

Enclosing class:

CollaborateBridge

public static class CollaborateBridge.GroupCollaborateBridgeGetAvailableUserListRequest
extends Request<CollaborateBridge.GroupCollaborateBridgeGetAvailableUserListResponse>

Get a list of users with the Collaborate – Audio service assigned that can be assigned to a collaborate bridge. For an Enterprise Group this will include all users in the group’s enterprise. The SearchCriteriaExactUserGroup parameter is only applicable for enterprise groups. The response is either GroupCollaborateBridgeGetAvailableUserListResponse 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 @NotNull @Valid Group	group
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

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

log

Constructor Summary

Constructors

Constructor	Description
GroupCollaborateBridgeGetAvailableUserListRequest()
GroupCollaborateBridgeGetAvailableUserListRequest(Group group)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
static CollaborateBridge.GroupCollaborateBridgeGetAvailableUserListRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
Group	getGroup()
Integer	getResponseSizeLimit()
SearchCriteriaDn[]	getSearchCriteriaDn()
SearchCriteriaExactUserDepartment	getSearchCriteriaExactUserDepartment()
SearchCriteriaExactUserGroup	getSearchCriteriaExactUserGroup()
SearchCriteriaExtension[]	getSearchCriteriaExtension()
SearchCriteriaUserFirstName[]	getSearchCriteriaUserFirstName()
SearchCriteriaUserId[]	getSearchCriteriaUserId()
SearchCriteriaUserLastName[]	getSearchCriteriaUserLastName()
CollaborateBridge.GroupCollaborateBridgeGetAvailableUserListRequest	setGroup(Group group)
CollaborateBridge.GroupCollaborateBridgeGetAvailableUserListRequest	setResponseSizeLimit(Integer responseSizeLimit)
CollaborateBridge.GroupCollaborateBridgeGetAvailableUserListRequest	setSearchCriteriaDn(SearchCriteriaDn... searchCriteriaDn)
CollaborateBridge.GroupCollaborateBridgeGetAvailableUserListRequest	setSearchCriteriaExactUserDepartment(SearchCriteriaExactUserDepartment searchCriteriaExactUserDepartment)
CollaborateBridge.GroupCollaborateBridgeGetAvailableUserListRequest	setSearchCriteriaExactUserGroup(SearchCriteriaExactUserGroup searchCriteriaExactUserGroup)
CollaborateBridge.GroupCollaborateBridgeGetAvailableUserListRequest	setSearchCriteriaExtension(SearchCriteriaExtension... searchCriteriaExtension)
CollaborateBridge.GroupCollaborateBridgeGetAvailableUserListRequest	setSearchCriteriaUserFirstName(SearchCriteriaUserFirstName... searchCriteriaUserFirstName)
CollaborateBridge.GroupCollaborateBridgeGetAvailableUserListRequest	setSearchCriteriaUserId(SearchCriteriaUserId... searchCriteriaUserId)
CollaborateBridge.GroupCollaborateBridgeGetAvailableUserListRequest	setSearchCriteriaUserLastName(SearchCriteriaUserLastName... searchCriteriaUserLastName)

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

group

@NotNull
@Valid
protected transient @NotNull @Valid Group group

responseSizeLimit

protected Integer responseSizeLimit

searchCriteriaUserLastName

@Valid
protected @Valid SearchCriteriaUserLastName[] searchCriteriaUserLastName

searchCriteriaUserFirstName

@Valid
protected @Valid SearchCriteriaUserFirstName[] searchCriteriaUserFirstName

searchCriteriaUserId

@Valid
protected @Valid SearchCriteriaUserId[] searchCriteriaUserId

searchCriteriaExactUserDepartment

@Valid
protected @Valid SearchCriteriaExactUserDepartment searchCriteriaExactUserDepartment

searchCriteriaExactUserGroup

@Valid
protected @Valid SearchCriteriaExactUserGroup searchCriteriaExactUserGroup

searchCriteriaDn

@Valid
protected @Valid SearchCriteriaDn[] searchCriteriaDn

searchCriteriaExtension

@Valid
protected @Valid SearchCriteriaExtension[] searchCriteriaExtension

Constructor Details

GroupCollaborateBridgeGetAvailableUserListRequest

public GroupCollaborateBridgeGetAvailableUserListRequest()

GroupCollaborateBridgeGetAvailableUserListRequest

public GroupCollaborateBridgeGetAvailableUserListRequest(Group group)

Method Details

setGroup

public CollaborateBridge.GroupCollaborateBridgeGetAvailableUserListRequest setGroup(Group group)

getGroup

public Group getGroup()

setResponseSizeLimit

public CollaborateBridge.GroupCollaborateBridgeGetAvailableUserListRequest setResponseSizeLimit(Integer responseSizeLimit)

getResponseSizeLimit

public Integer getResponseSizeLimit()

setSearchCriteriaUserLastName

public CollaborateBridge.GroupCollaborateBridgeGetAvailableUserListRequest setSearchCriteriaUserLastName(SearchCriteriaUserLastName... searchCriteriaUserLastName)

getSearchCriteriaUserLastName

public SearchCriteriaUserLastName[] getSearchCriteriaUserLastName()

setSearchCriteriaUserFirstName

public CollaborateBridge.GroupCollaborateBridgeGetAvailableUserListRequest setSearchCriteriaUserFirstName(SearchCriteriaUserFirstName... searchCriteriaUserFirstName)

getSearchCriteriaUserFirstName

public SearchCriteriaUserFirstName[] getSearchCriteriaUserFirstName()

setSearchCriteriaUserId

public CollaborateBridge.GroupCollaborateBridgeGetAvailableUserListRequest setSearchCriteriaUserId(SearchCriteriaUserId... searchCriteriaUserId)

getSearchCriteriaUserId

public SearchCriteriaUserId[] getSearchCriteriaUserId()

setSearchCriteriaExactUserDepartment

public CollaborateBridge.GroupCollaborateBridgeGetAvailableUserListRequest setSearchCriteriaExactUserDepartment(SearchCriteriaExactUserDepartment searchCriteriaExactUserDepartment)

getSearchCriteriaExactUserDepartment

public SearchCriteriaExactUserDepartment getSearchCriteriaExactUserDepartment()

setSearchCriteriaExactUserGroup

public CollaborateBridge.GroupCollaborateBridgeGetAvailableUserListRequest setSearchCriteriaExactUserGroup(SearchCriteriaExactUserGroup searchCriteriaExactUserGroup)

getSearchCriteriaExactUserGroup

public SearchCriteriaExactUserGroup getSearchCriteriaExactUserGroup()

setSearchCriteriaDn

public CollaborateBridge.GroupCollaborateBridgeGetAvailableUserListRequest setSearchCriteriaDn(SearchCriteriaDn... searchCriteriaDn)

getSearchCriteriaDn

public SearchCriteriaDn[] getSearchCriteriaDn()

setSearchCriteriaExtension

public CollaborateBridge.GroupCollaborateBridgeGetAvailableUserListRequest setSearchCriteriaExtension(SearchCriteriaExtension... searchCriteriaExtension)

getSearchCriteriaExtension

public SearchCriteriaExtension[] getSearchCriteriaExtension()

getEmptyObject

public static CollaborateBridge.GroupCollaborateBridgeGetAvailableUserListRequest 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<CollaborateBridge.GroupCollaborateBridgeGetAvailableUserListResponse>