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

Class EnterpriseVirtualOnNetEnterpriseExtensions.EnterpriseVirtualOnNetEnterpriseExtensionsGetUserListRequest

java.lang.Object

co.ecg.alpaca.toolkit.messaging.request.Request<EnterpriseVirtualOnNetEnterpriseExtensions.EnterpriseVirtualOnNetEnterpriseExtensionsGetUserListResponse>

co.ecg.alpaca.toolkit.generated.services.EnterpriseVirtualOnNetEnterpriseExtensions.EnterpriseVirtualOnNetEnterpriseExtensionsGetUserListRequest

Enclosing class:

EnterpriseVirtualOnNetEnterpriseExtensions

public static class EnterpriseVirtualOnNetEnterpriseExtensions.EnterpriseVirtualOnNetEnterpriseExtensionsGetUserListRequest
extends Request<EnterpriseVirtualOnNetEnterpriseExtensions.EnterpriseVirtualOnNetEnterpriseExtensionsGetUserListResponse>

Request the list of Virtual On-Net users in an Enterprise. 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 EnterpriseVirtualOnNetEnterpriseExtensionsGetUserListResponse 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 @Valid Enterprise	enterprise
protected Integer	responseSizeLimit
protected @Valid SearchCriteriaDn[]	searchCriteriaDn
protected @Valid SearchCriteriaExactVirtualOnNetCallTypeName	searchCriteriaExactVirtualOnNetCallTypeName
protected @Valid SearchCriteriaExtension[]	searchCriteriaExtension
protected @Valid SearchCriteriaGroupLocationCode[]	searchCriteriaGroupLocationCode
protected @Valid SearchCriteriaUserFirstName[]	searchCriteriaUserFirstName
protected @Valid SearchCriteriaUserLastName[]	searchCriteriaUserLastName

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

log

Constructor Summary

Constructors

Constructor	Description
EnterpriseVirtualOnNetEnterpriseExtensionsGetUserListRequest()
EnterpriseVirtualOnNetEnterpriseExtensionsGetUserListRequest(Enterprise enterprise)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
static EnterpriseVirtualOnNetEnterpriseExtensions.EnterpriseVirtualOnNetEnterpriseExtensionsGetUserListRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
Enterprise	getEnterprise()
Integer	getResponseSizeLimit()
SearchCriteriaDn[]	getSearchCriteriaDn()
SearchCriteriaExactVirtualOnNetCallTypeName	getSearchCriteriaExactVirtualOnNetCallTypeName()
SearchCriteriaExtension[]	getSearchCriteriaExtension()
SearchCriteriaGroupLocationCode[]	getSearchCriteriaGroupLocationCode()
SearchCriteriaUserFirstName[]	getSearchCriteriaUserFirstName()
SearchCriteriaUserLastName[]	getSearchCriteriaUserLastName()
EnterpriseVirtualOnNetEnterpriseExtensions.EnterpriseVirtualOnNetEnterpriseExtensionsGetUserListRequest	setEnterprise(Enterprise enterprise)
EnterpriseVirtualOnNetEnterpriseExtensions.EnterpriseVirtualOnNetEnterpriseExtensionsGetUserListRequest	setResponseSizeLimit(Integer responseSizeLimit)
EnterpriseVirtualOnNetEnterpriseExtensions.EnterpriseVirtualOnNetEnterpriseExtensionsGetUserListRequest	setSearchCriteriaDn(SearchCriteriaDn... searchCriteriaDn)
EnterpriseVirtualOnNetEnterpriseExtensions.EnterpriseVirtualOnNetEnterpriseExtensionsGetUserListRequest	setSearchCriteriaExactVirtualOnNetCallTypeName(SearchCriteriaExactVirtualOnNetCallTypeName searchCriteriaExactVirtualOnNetCallTypeName)
EnterpriseVirtualOnNetEnterpriseExtensions.EnterpriseVirtualOnNetEnterpriseExtensionsGetUserListRequest	setSearchCriteriaExtension(SearchCriteriaExtension... searchCriteriaExtension)
EnterpriseVirtualOnNetEnterpriseExtensions.EnterpriseVirtualOnNetEnterpriseExtensionsGetUserListRequest	setSearchCriteriaGroupLocationCode(SearchCriteriaGroupLocationCode... searchCriteriaGroupLocationCode)
EnterpriseVirtualOnNetEnterpriseExtensions.EnterpriseVirtualOnNetEnterpriseExtensionsGetUserListRequest	setSearchCriteriaUserFirstName(SearchCriteriaUserFirstName... searchCriteriaUserFirstName)
EnterpriseVirtualOnNetEnterpriseExtensions.EnterpriseVirtualOnNetEnterpriseExtensionsGetUserListRequest	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

enterprise

@NotNull
@Valid
protected transient @NotNull @Valid Enterprise enterprise

responseSizeLimit

protected Integer responseSizeLimit

searchCriteriaUserLastName

@Valid
protected @Valid SearchCriteriaUserLastName[] searchCriteriaUserLastName

searchCriteriaUserFirstName

@Valid
protected @Valid SearchCriteriaUserFirstName[] searchCriteriaUserFirstName

searchCriteriaDn

@Valid
protected @Valid SearchCriteriaDn[] searchCriteriaDn

searchCriteriaGroupLocationCode

@Valid
protected @Valid SearchCriteriaGroupLocationCode[] searchCriteriaGroupLocationCode

searchCriteriaExtension

@Valid
protected @Valid SearchCriteriaExtension[] searchCriteriaExtension

searchCriteriaExactVirtualOnNetCallTypeName

@Valid
protected @Valid SearchCriteriaExactVirtualOnNetCallTypeName searchCriteriaExactVirtualOnNetCallTypeName

Constructor Details

EnterpriseVirtualOnNetEnterpriseExtensionsGetUserListRequest

public EnterpriseVirtualOnNetEnterpriseExtensionsGetUserListRequest()

EnterpriseVirtualOnNetEnterpriseExtensionsGetUserListRequest

public EnterpriseVirtualOnNetEnterpriseExtensionsGetUserListRequest(Enterprise enterprise)

Method Details

setEnterprise

public EnterpriseVirtualOnNetEnterpriseExtensions.EnterpriseVirtualOnNetEnterpriseExtensionsGetUserListRequest setEnterprise(Enterprise enterprise)

getEnterprise

public Enterprise getEnterprise()

setResponseSizeLimit

public EnterpriseVirtualOnNetEnterpriseExtensions.EnterpriseVirtualOnNetEnterpriseExtensionsGetUserListRequest setResponseSizeLimit(Integer responseSizeLimit)

getResponseSizeLimit

public Integer getResponseSizeLimit()

setSearchCriteriaUserLastName

public EnterpriseVirtualOnNetEnterpriseExtensions.EnterpriseVirtualOnNetEnterpriseExtensionsGetUserListRequest setSearchCriteriaUserLastName(SearchCriteriaUserLastName... searchCriteriaUserLastName)

getSearchCriteriaUserLastName

public SearchCriteriaUserLastName[] getSearchCriteriaUserLastName()

setSearchCriteriaUserFirstName

public EnterpriseVirtualOnNetEnterpriseExtensions.EnterpriseVirtualOnNetEnterpriseExtensionsGetUserListRequest setSearchCriteriaUserFirstName(SearchCriteriaUserFirstName... searchCriteriaUserFirstName)

getSearchCriteriaUserFirstName

public SearchCriteriaUserFirstName[] getSearchCriteriaUserFirstName()

setSearchCriteriaDn

public EnterpriseVirtualOnNetEnterpriseExtensions.EnterpriseVirtualOnNetEnterpriseExtensionsGetUserListRequest setSearchCriteriaDn(SearchCriteriaDn... searchCriteriaDn)

getSearchCriteriaDn

public SearchCriteriaDn[] getSearchCriteriaDn()

setSearchCriteriaGroupLocationCode

public EnterpriseVirtualOnNetEnterpriseExtensions.EnterpriseVirtualOnNetEnterpriseExtensionsGetUserListRequest setSearchCriteriaGroupLocationCode(SearchCriteriaGroupLocationCode... searchCriteriaGroupLocationCode)

getSearchCriteriaGroupLocationCode

public SearchCriteriaGroupLocationCode[] getSearchCriteriaGroupLocationCode()

setSearchCriteriaExtension

public EnterpriseVirtualOnNetEnterpriseExtensions.EnterpriseVirtualOnNetEnterpriseExtensionsGetUserListRequest setSearchCriteriaExtension(SearchCriteriaExtension... searchCriteriaExtension)

getSearchCriteriaExtension

public SearchCriteriaExtension[] getSearchCriteriaExtension()

setSearchCriteriaExactVirtualOnNetCallTypeName

public EnterpriseVirtualOnNetEnterpriseExtensions.EnterpriseVirtualOnNetEnterpriseExtensionsGetUserListRequest setSearchCriteriaExactVirtualOnNetCallTypeName(SearchCriteriaExactVirtualOnNetCallTypeName searchCriteriaExactVirtualOnNetCallTypeName)

getSearchCriteriaExactVirtualOnNetCallTypeName

public SearchCriteriaExactVirtualOnNetCallTypeName getSearchCriteriaExactVirtualOnNetCallTypeName()

getEmptyObject

public static EnterpriseVirtualOnNetEnterpriseExtensions.EnterpriseVirtualOnNetEnterpriseExtensionsGetUserListRequest 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<EnterpriseVirtualOnNetEnterpriseExtensions.EnterpriseVirtualOnNetEnterpriseExtensionsGetUserListResponse>