Package co.ecg.alpaca.toolkit.generated.services

Class GroupTrunkGroup.GroupEnterpriseTrunkGetUserListRequest

java.lang.Object

co.ecg.alpaca.toolkit.messaging.request.Request<GroupTrunkGroup.GroupEnterpriseTrunkGetUserListResponse>

co.ecg.alpaca.toolkit.generated.services.GroupTrunkGroup.GroupEnterpriseTrunkGetUserListRequest

Enclosing class:

GroupTrunkGroup

public static class GroupTrunkGroup.GroupEnterpriseTrunkGetUserListRequest
extends Request<GroupTrunkGroup.GroupEnterpriseTrunkGetUserListResponse>

Request the list of users in an enterprise trunk. 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 GroupEnterpriseTrunkGetUserListResponse 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	Description
protected @NotNull @Size(min=1,max=30) String	enterpriseTrunkName
protected @NotNull @Valid Group	group
protected Integer	responseSizeLimit
protected @Valid SearchCriteriaAlternateTrunkIdentity[]	searchCriteriaAlternateTrunkIdentity
protected @Valid SearchCriteriaAlternateTrunkIdentityDomain[]	searchCriteriaAlternateTrunkIdentityDomain
protected @Valid SearchCriteriaDn[]	searchCriteriaDn
protected @Valid SearchCriteriaExactUserDepartment	searchCriteriaExactUserDepartment
protected @Valid SearchCriteriaExactUserRouteListAssigned	searchCriteriaExactUserRouteListAssigned
protected @Valid SearchCriteriaExtension[]	searchCriteriaExtension
protected @Valid SearchCriteriaGroupId[]	searchCriteriaGroupId
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
GroupEnterpriseTrunkGetUserListRequest()
GroupEnterpriseTrunkGetUserListRequest(Group group, String enterpriseTrunkName)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
static GroupTrunkGroup.GroupEnterpriseTrunkGetUserListRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
String	getEnterpriseTrunkName()
Group	getGroup()
Integer	getResponseSizeLimit()
SearchCriteriaAlternateTrunkIdentity[]	getSearchCriteriaAlternateTrunkIdentity()
SearchCriteriaAlternateTrunkIdentityDomain[]	getSearchCriteriaAlternateTrunkIdentityDomain()
SearchCriteriaDn[]	getSearchCriteriaDn()
SearchCriteriaExactUserDepartment	getSearchCriteriaExactUserDepartment()
SearchCriteriaExactUserRouteListAssigned	getSearchCriteriaExactUserRouteListAssigned()
SearchCriteriaExtension[]	getSearchCriteriaExtension()
SearchCriteriaGroupId[]	getSearchCriteriaGroupId()
SearchCriteriaUserFirstName[]	getSearchCriteriaUserFirstName()
SearchCriteriaUserId[]	getSearchCriteriaUserId()
SearchCriteriaUserLastName[]	getSearchCriteriaUserLastName()
GroupTrunkGroup.GroupEnterpriseTrunkGetUserListRequest	setEnterpriseTrunkName(String enterpriseTrunkName)
GroupTrunkGroup.GroupEnterpriseTrunkGetUserListRequest	setGroup(Group group)
GroupTrunkGroup.GroupEnterpriseTrunkGetUserListRequest	setResponseSizeLimit(Integer responseSizeLimit)
GroupTrunkGroup.GroupEnterpriseTrunkGetUserListRequest	setSearchCriteriaAlternateTrunkIdentity(SearchCriteriaAlternateTrunkIdentity... searchCriteriaAlternateTrunkIdentity)
GroupTrunkGroup.GroupEnterpriseTrunkGetUserListRequest	setSearchCriteriaAlternateTrunkIdentityDomain(SearchCriteriaAlternateTrunkIdentityDomain... searchCriteriaAlternateTrunkIdentityDomain)
GroupTrunkGroup.GroupEnterpriseTrunkGetUserListRequest	setSearchCriteriaDn(SearchCriteriaDn... searchCriteriaDn)
GroupTrunkGroup.GroupEnterpriseTrunkGetUserListRequest	setSearchCriteriaExactUserDepartment(SearchCriteriaExactUserDepartment searchCriteriaExactUserDepartment)
GroupTrunkGroup.GroupEnterpriseTrunkGetUserListRequest	setSearchCriteriaExactUserRouteListAssigned(SearchCriteriaExactUserRouteListAssigned searchCriteriaExactUserRouteListAssigned)
GroupTrunkGroup.GroupEnterpriseTrunkGetUserListRequest	setSearchCriteriaExtension(SearchCriteriaExtension... searchCriteriaExtension)
GroupTrunkGroup.GroupEnterpriseTrunkGetUserListRequest	setSearchCriteriaGroupId(SearchCriteriaGroupId... searchCriteriaGroupId)
GroupTrunkGroup.GroupEnterpriseTrunkGetUserListRequest	setSearchCriteriaUserFirstName(SearchCriteriaUserFirstName... searchCriteriaUserFirstName)
GroupTrunkGroup.GroupEnterpriseTrunkGetUserListRequest	setSearchCriteriaUserId(SearchCriteriaUserId... searchCriteriaUserId)
GroupTrunkGroup.GroupEnterpriseTrunkGetUserListRequest	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 Detail

group

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

enterpriseTrunkName

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

responseSizeLimit

protected Integer responseSizeLimit

searchCriteriaUserLastName

@Valid
protected @Valid SearchCriteriaUserLastName[] searchCriteriaUserLastName

searchCriteriaUserFirstName

@Valid
protected @Valid SearchCriteriaUserFirstName[] searchCriteriaUserFirstName

searchCriteriaDn

@Valid
protected @Valid SearchCriteriaDn[] searchCriteriaDn

searchCriteriaUserId

@Valid
protected @Valid SearchCriteriaUserId[] searchCriteriaUserId

searchCriteriaGroupId

@Valid
protected @Valid SearchCriteriaGroupId[] searchCriteriaGroupId

searchCriteriaAlternateTrunkIdentity

@Valid
protected @Valid SearchCriteriaAlternateTrunkIdentity[] searchCriteriaAlternateTrunkIdentity

searchCriteriaAlternateTrunkIdentityDomain

@Valid
protected @Valid SearchCriteriaAlternateTrunkIdentityDomain[] searchCriteriaAlternateTrunkIdentityDomain

searchCriteriaExtension

@Valid
protected @Valid SearchCriteriaExtension[] searchCriteriaExtension

searchCriteriaExactUserDepartment

@Valid
protected @Valid SearchCriteriaExactUserDepartment searchCriteriaExactUserDepartment

searchCriteriaExactUserRouteListAssigned

@Valid
protected @Valid SearchCriteriaExactUserRouteListAssigned searchCriteriaExactUserRouteListAssigned

Constructor Detail

GroupEnterpriseTrunkGetUserListRequest

public GroupEnterpriseTrunkGetUserListRequest()

GroupEnterpriseTrunkGetUserListRequest

public GroupEnterpriseTrunkGetUserListRequest(Group group,
                                              String enterpriseTrunkName)

Method Detail

setGroup

public GroupTrunkGroup.GroupEnterpriseTrunkGetUserListRequest setGroup(Group group)

getGroup

public Group getGroup()

setEnterpriseTrunkName

public GroupTrunkGroup.GroupEnterpriseTrunkGetUserListRequest setEnterpriseTrunkName(String enterpriseTrunkName)

getEnterpriseTrunkName

public String getEnterpriseTrunkName()

setResponseSizeLimit

public GroupTrunkGroup.GroupEnterpriseTrunkGetUserListRequest setResponseSizeLimit(Integer responseSizeLimit)

getResponseSizeLimit

public Integer getResponseSizeLimit()

setSearchCriteriaUserLastName

public GroupTrunkGroup.GroupEnterpriseTrunkGetUserListRequest setSearchCriteriaUserLastName(SearchCriteriaUserLastName... searchCriteriaUserLastName)

getSearchCriteriaUserLastName

public SearchCriteriaUserLastName[] getSearchCriteriaUserLastName()

setSearchCriteriaUserFirstName

public GroupTrunkGroup.GroupEnterpriseTrunkGetUserListRequest setSearchCriteriaUserFirstName(SearchCriteriaUserFirstName... searchCriteriaUserFirstName)

getSearchCriteriaUserFirstName

public SearchCriteriaUserFirstName[] getSearchCriteriaUserFirstName()

setSearchCriteriaDn

public GroupTrunkGroup.GroupEnterpriseTrunkGetUserListRequest setSearchCriteriaDn(SearchCriteriaDn... searchCriteriaDn)

getSearchCriteriaDn

public SearchCriteriaDn[] getSearchCriteriaDn()

setSearchCriteriaUserId

public GroupTrunkGroup.GroupEnterpriseTrunkGetUserListRequest setSearchCriteriaUserId(SearchCriteriaUserId... searchCriteriaUserId)

getSearchCriteriaUserId

public SearchCriteriaUserId[] getSearchCriteriaUserId()

setSearchCriteriaGroupId

public GroupTrunkGroup.GroupEnterpriseTrunkGetUserListRequest setSearchCriteriaGroupId(SearchCriteriaGroupId... searchCriteriaGroupId)

getSearchCriteriaGroupId

public SearchCriteriaGroupId[] getSearchCriteriaGroupId()

setSearchCriteriaAlternateTrunkIdentity

public GroupTrunkGroup.GroupEnterpriseTrunkGetUserListRequest setSearchCriteriaAlternateTrunkIdentity(SearchCriteriaAlternateTrunkIdentity... searchCriteriaAlternateTrunkIdentity)

getSearchCriteriaAlternateTrunkIdentity

public SearchCriteriaAlternateTrunkIdentity[] getSearchCriteriaAlternateTrunkIdentity()

setSearchCriteriaAlternateTrunkIdentityDomain

public GroupTrunkGroup.GroupEnterpriseTrunkGetUserListRequest setSearchCriteriaAlternateTrunkIdentityDomain(SearchCriteriaAlternateTrunkIdentityDomain... searchCriteriaAlternateTrunkIdentityDomain)

getSearchCriteriaAlternateTrunkIdentityDomain

public SearchCriteriaAlternateTrunkIdentityDomain[] getSearchCriteriaAlternateTrunkIdentityDomain()

setSearchCriteriaExtension

public GroupTrunkGroup.GroupEnterpriseTrunkGetUserListRequest setSearchCriteriaExtension(SearchCriteriaExtension... searchCriteriaExtension)

getSearchCriteriaExtension

public SearchCriteriaExtension[] getSearchCriteriaExtension()

setSearchCriteriaExactUserDepartment

public GroupTrunkGroup.GroupEnterpriseTrunkGetUserListRequest setSearchCriteriaExactUserDepartment(SearchCriteriaExactUserDepartment searchCriteriaExactUserDepartment)

getSearchCriteriaExactUserDepartment

public SearchCriteriaExactUserDepartment getSearchCriteriaExactUserDepartment()

setSearchCriteriaExactUserRouteListAssigned

public GroupTrunkGroup.GroupEnterpriseTrunkGetUserListRequest setSearchCriteriaExactUserRouteListAssigned(SearchCriteriaExactUserRouteListAssigned searchCriteriaExactUserRouteListAssigned)

getSearchCriteriaExactUserRouteListAssigned

public SearchCriteriaExactUserRouteListAssigned getSearchCriteriaExactUserRouteListAssigned()

getEmptyObject

public static GroupTrunkGroup.GroupEnterpriseTrunkGetUserListRequest 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<GroupTrunkGroup.GroupEnterpriseTrunkGetUserListResponse>