Package co.ecg.alpaca.toolkit.generated

Class ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetUserListRequest

java.lang.Object

co.ecg.alpaca.toolkit.messaging.request.Request<ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetUserListResponse>

co.ecg.alpaca.toolkit.generated.ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetUserListRequest

Enclosing class:

ServiceProviderAccessDevice

public static class ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetUserListRequest
extends Request<ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetUserListResponse>

Requests the list of users on a specified device. The response is either ServiceProviderAccessDeviceGetResponse21sp1 or ErrorResponse. The following elements are only used in XS data mode and ignored in AS data mode: searchCriteriaAccessDeviceEndpointPrivateIdentity

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 SearchCriteriaAccessDeviceEndpointPrivateIdentity[]	searchCriteriaAccessDeviceEndpointPrivateIdentity
protected @Valid SearchCriteriaDn[]	searchCriteriaDn
protected @Valid SearchCriteriaExactEndpointType21sp1	searchCriteriaExactEndpointType
protected @Valid SearchCriteriaExactPortNumber	searchCriteriaExactPortNumber
protected @Valid SearchCriteriaExactUserDepartment	searchCriteriaExactUserDepartment
protected @Valid SearchCriteriaExactUserType	searchCriteriaExactUserType
protected @Valid SearchCriteriaExtension[]	searchCriteriaExtension
protected @Valid SearchCriteriaGroupId[]	searchCriteriaGroupId
protected @Valid SearchCriteriaLinePortDomain[]	searchCriteriaLinePortDomain
protected @Valid SearchCriteriaLinePortUserPart[]	searchCriteriaLinePortUserPart
protected @Valid SearchCriteriaUserFirstName[]	searchCriteriaUserFirstName
protected @Valid SearchCriteriaUserId[]	searchCriteriaUserId
protected @Valid SearchCriteriaUserLastName[]	searchCriteriaUserLastName
protected @NotNull @Valid ServiceProviderAccessDevice	serviceProviderAccessDevice

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

log

Constructor Summary

Constructors

Constructor	Description
ServiceProviderAccessDeviceGetUserListRequest()
ServiceProviderAccessDeviceGetUserListRequest(ServiceProviderAccessDevice serviceProviderAccessDevice)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
static ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetUserListRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
Integer	getResponseSizeLimit()
SearchCriteriaAccessDeviceEndpointPrivateIdentity[]	getSearchCriteriaAccessDeviceEndpointPrivateIdentity()
SearchCriteriaDn[]	getSearchCriteriaDn()
SearchCriteriaExactEndpointType21sp1	getSearchCriteriaExactEndpointType()
SearchCriteriaExactPortNumber	getSearchCriteriaExactPortNumber()
SearchCriteriaExactUserDepartment	getSearchCriteriaExactUserDepartment()
SearchCriteriaExactUserType	getSearchCriteriaExactUserType()
SearchCriteriaExtension[]	getSearchCriteriaExtension()
SearchCriteriaGroupId[]	getSearchCriteriaGroupId()
SearchCriteriaLinePortDomain[]	getSearchCriteriaLinePortDomain()
SearchCriteriaLinePortUserPart[]	getSearchCriteriaLinePortUserPart()
SearchCriteriaUserFirstName[]	getSearchCriteriaUserFirstName()
SearchCriteriaUserId[]	getSearchCriteriaUserId()
SearchCriteriaUserLastName[]	getSearchCriteriaUserLastName()
ServiceProviderAccessDevice	getServiceProviderAccessDevice()
ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetUserListRequest	setResponseSizeLimit(Integer responseSizeLimit)
ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetUserListRequest	setSearchCriteriaAccessDeviceEndpointPrivateIdentity(SearchCriteriaAccessDeviceEndpointPrivateIdentity... searchCriteriaAccessDeviceEndpointPrivateIdentity)
ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetUserListRequest	setSearchCriteriaDn(SearchCriteriaDn... searchCriteriaDn)
ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetUserListRequest	setSearchCriteriaExactEndpointType(SearchCriteriaExactEndpointType21sp1 searchCriteriaExactEndpointType)
ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetUserListRequest	setSearchCriteriaExactPortNumber(SearchCriteriaExactPortNumber searchCriteriaExactPortNumber)
ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetUserListRequest	setSearchCriteriaExactUserDepartment(SearchCriteriaExactUserDepartment searchCriteriaExactUserDepartment)
ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetUserListRequest	setSearchCriteriaExactUserType(SearchCriteriaExactUserType searchCriteriaExactUserType)
ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetUserListRequest	setSearchCriteriaExtension(SearchCriteriaExtension... searchCriteriaExtension)
ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetUserListRequest	setSearchCriteriaGroupId(SearchCriteriaGroupId... searchCriteriaGroupId)
ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetUserListRequest	setSearchCriteriaLinePortDomain(SearchCriteriaLinePortDomain... searchCriteriaLinePortDomain)
ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetUserListRequest	setSearchCriteriaLinePortUserPart(SearchCriteriaLinePortUserPart... searchCriteriaLinePortUserPart)
ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetUserListRequest	setSearchCriteriaUserFirstName(SearchCriteriaUserFirstName... searchCriteriaUserFirstName)
ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetUserListRequest	setSearchCriteriaUserId(SearchCriteriaUserId... searchCriteriaUserId)
ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetUserListRequest	setSearchCriteriaUserLastName(SearchCriteriaUserLastName... searchCriteriaUserLastName)
ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetUserListRequest	setServiceProviderAccessDevice(ServiceProviderAccessDevice serviceProviderAccessDevice)

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

serviceProviderAccessDevice

@NotNull
@Valid
protected transient @NotNull @Valid ServiceProviderAccessDevice serviceProviderAccessDevice

responseSizeLimit

protected Integer responseSizeLimit

searchCriteriaLinePortUserPart

@Valid
protected @Valid SearchCriteriaLinePortUserPart[] searchCriteriaLinePortUserPart

searchCriteriaLinePortDomain

@Valid
protected @Valid SearchCriteriaLinePortDomain[] searchCriteriaLinePortDomain

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

searchCriteriaExactEndpointType

@Valid
protected @Valid SearchCriteriaExactEndpointType21sp1 searchCriteriaExactEndpointType

searchCriteriaExactUserType

@Valid
protected @Valid SearchCriteriaExactUserType searchCriteriaExactUserType

searchCriteriaExtension

@Valid
protected @Valid SearchCriteriaExtension[] searchCriteriaExtension

searchCriteriaExactUserDepartment

@Valid
protected @Valid SearchCriteriaExactUserDepartment searchCriteriaExactUserDepartment

searchCriteriaExactPortNumber

@Valid
protected @Valid SearchCriteriaExactPortNumber searchCriteriaExactPortNumber

searchCriteriaAccessDeviceEndpointPrivateIdentity

@Valid
protected @Valid SearchCriteriaAccessDeviceEndpointPrivateIdentity[] searchCriteriaAccessDeviceEndpointPrivateIdentity

Constructor Details

ServiceProviderAccessDeviceGetUserListRequest

public ServiceProviderAccessDeviceGetUserListRequest()

ServiceProviderAccessDeviceGetUserListRequest

public ServiceProviderAccessDeviceGetUserListRequest(ServiceProviderAccessDevice serviceProviderAccessDevice)

Method Details

setServiceProviderAccessDevice

public ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetUserListRequest setServiceProviderAccessDevice(ServiceProviderAccessDevice serviceProviderAccessDevice)

getServiceProviderAccessDevice

public ServiceProviderAccessDevice getServiceProviderAccessDevice()

setResponseSizeLimit

public ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetUserListRequest setResponseSizeLimit(Integer responseSizeLimit)

getResponseSizeLimit

public Integer getResponseSizeLimit()

setSearchCriteriaLinePortUserPart

public ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetUserListRequest setSearchCriteriaLinePortUserPart(SearchCriteriaLinePortUserPart... searchCriteriaLinePortUserPart)

getSearchCriteriaLinePortUserPart

public SearchCriteriaLinePortUserPart[] getSearchCriteriaLinePortUserPart()

setSearchCriteriaLinePortDomain

public ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetUserListRequest setSearchCriteriaLinePortDomain(SearchCriteriaLinePortDomain... searchCriteriaLinePortDomain)

getSearchCriteriaLinePortDomain

public SearchCriteriaLinePortDomain[] getSearchCriteriaLinePortDomain()

setSearchCriteriaUserLastName

public ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetUserListRequest setSearchCriteriaUserLastName(SearchCriteriaUserLastName... searchCriteriaUserLastName)

getSearchCriteriaUserLastName

public SearchCriteriaUserLastName[] getSearchCriteriaUserLastName()

setSearchCriteriaUserFirstName

public ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetUserListRequest setSearchCriteriaUserFirstName(SearchCriteriaUserFirstName... searchCriteriaUserFirstName)

getSearchCriteriaUserFirstName

public SearchCriteriaUserFirstName[] getSearchCriteriaUserFirstName()

setSearchCriteriaDn

public ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetUserListRequest setSearchCriteriaDn(SearchCriteriaDn... searchCriteriaDn)

getSearchCriteriaDn

public SearchCriteriaDn[] getSearchCriteriaDn()

setSearchCriteriaUserId

public ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetUserListRequest setSearchCriteriaUserId(SearchCriteriaUserId... searchCriteriaUserId)

getSearchCriteriaUserId

public SearchCriteriaUserId[] getSearchCriteriaUserId()

setSearchCriteriaGroupId

public ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetUserListRequest setSearchCriteriaGroupId(SearchCriteriaGroupId... searchCriteriaGroupId)

getSearchCriteriaGroupId

public SearchCriteriaGroupId[] getSearchCriteriaGroupId()

setSearchCriteriaExactEndpointType

public ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetUserListRequest setSearchCriteriaExactEndpointType(SearchCriteriaExactEndpointType21sp1 searchCriteriaExactEndpointType)

getSearchCriteriaExactEndpointType

public SearchCriteriaExactEndpointType21sp1 getSearchCriteriaExactEndpointType()

setSearchCriteriaExactUserType

public ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetUserListRequest setSearchCriteriaExactUserType(SearchCriteriaExactUserType searchCriteriaExactUserType)

getSearchCriteriaExactUserType

public SearchCriteriaExactUserType getSearchCriteriaExactUserType()

setSearchCriteriaExtension

public ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetUserListRequest setSearchCriteriaExtension(SearchCriteriaExtension... searchCriteriaExtension)

getSearchCriteriaExtension

public SearchCriteriaExtension[] getSearchCriteriaExtension()

setSearchCriteriaExactUserDepartment

public ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetUserListRequest setSearchCriteriaExactUserDepartment(SearchCriteriaExactUserDepartment searchCriteriaExactUserDepartment)

getSearchCriteriaExactUserDepartment

public SearchCriteriaExactUserDepartment getSearchCriteriaExactUserDepartment()

setSearchCriteriaExactPortNumber

public ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetUserListRequest setSearchCriteriaExactPortNumber(SearchCriteriaExactPortNumber searchCriteriaExactPortNumber)

getSearchCriteriaExactPortNumber

public SearchCriteriaExactPortNumber getSearchCriteriaExactPortNumber()

setSearchCriteriaAccessDeviceEndpointPrivateIdentity

public ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetUserListRequest setSearchCriteriaAccessDeviceEndpointPrivateIdentity(SearchCriteriaAccessDeviceEndpointPrivateIdentity... searchCriteriaAccessDeviceEndpointPrivateIdentity)

getSearchCriteriaAccessDeviceEndpointPrivateIdentity

public SearchCriteriaAccessDeviceEndpointPrivateIdentity[] getSearchCriteriaAccessDeviceEndpointPrivateIdentity()

getEmptyObject

public static ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetUserListRequest 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<ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetUserListResponse>