Package co.ecg.alpaca.toolkit.generated

Class BWSystem.SystemEndpointGetListRequest

java.lang.Object

co.ecg.alpaca.toolkit.messaging.request.Request<BWSystem.SystemEndpointGetListResponse>

co.ecg.alpaca.toolkit.generated.BWSystem.SystemEndpointGetListRequest

Enclosing class:

BWSystem

public static class BWSystem.SystemEndpointGetListRequest
extends Request<BWSystem.SystemEndpointGetListResponse>

Request to search endpoints in the system. If reseller administrator sends the request, searchCriteriaResellerId is ignored. All endpoints in the administrator's reseller meeting the search criteria are returned. The response is either SystemEndpointGetListResponse or ErrorResponse. The following data elements are only used in AS data mode: searchCriteriaResellerId

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 SearchCriteriaDeviceMACAddress[]	searchCriteriaDeviceMACAddress
protected @Valid SearchCriteriaDeviceName[]	searchCriteriaDeviceName
protected @Valid SearchCriteriaDeviceNetAddress[]	searchCriteriaDeviceNetAddress
protected @Valid SearchCriteriaDeviceType[]	searchCriteriaDeviceType
protected @Valid SearchCriteriaDn[]	searchCriteriaDn
protected @Valid SearchCriteriaExactOrganizationType	searchCriteriaExactOrganizationType
protected @Valid SearchCriteriaExtension[]	searchCriteriaExtension
protected @Valid SearchCriteriaGroupId[]	searchCriteriaGroupId
protected @Valid SearchCriteriaLinePortDomain[]	searchCriteriaLinePortDomain
protected @Valid SearchCriteriaLinePortUserPart[]	searchCriteriaLinePortUserPart
protected @Valid SearchCriteriaResellerId[]	searchCriteriaResellerId
protected @Valid SearchCriteriaServiceProviderId[]	searchCriteriaServiceProviderId
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
SystemEndpointGetListRequest()
SystemEndpointGetListRequest(BroadWorksServer broadWorksServer)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
Integer	getResponseSizeLimit()
SearchCriteriaDeviceMACAddress[]	getSearchCriteriaDeviceMACAddress()
SearchCriteriaDeviceName[]	getSearchCriteriaDeviceName()
SearchCriteriaDeviceNetAddress[]	getSearchCriteriaDeviceNetAddress()
SearchCriteriaDeviceType[]	getSearchCriteriaDeviceType()
SearchCriteriaDn[]	getSearchCriteriaDn()
SearchCriteriaExactOrganizationType	getSearchCriteriaExactOrganizationType()
SearchCriteriaExtension[]	getSearchCriteriaExtension()
SearchCriteriaGroupId[]	getSearchCriteriaGroupId()
SearchCriteriaLinePortDomain[]	getSearchCriteriaLinePortDomain()
SearchCriteriaLinePortUserPart[]	getSearchCriteriaLinePortUserPart()
SearchCriteriaResellerId[]	getSearchCriteriaResellerId()
SearchCriteriaServiceProviderId[]	getSearchCriteriaServiceProviderId()
SearchCriteriaUserFirstName[]	getSearchCriteriaUserFirstName()
SearchCriteriaUserId[]	getSearchCriteriaUserId()
SearchCriteriaUserLastName[]	getSearchCriteriaUserLastName()
BWSystem.SystemEndpointGetListRequest	setResponseSizeLimit(Integer responseSizeLimit)
BWSystem.SystemEndpointGetListRequest	setSearchCriteriaDeviceMACAddress(SearchCriteriaDeviceMACAddress... searchCriteriaDeviceMACAddress)
BWSystem.SystemEndpointGetListRequest	setSearchCriteriaDeviceName(SearchCriteriaDeviceName... searchCriteriaDeviceName)
BWSystem.SystemEndpointGetListRequest	setSearchCriteriaDeviceNetAddress(SearchCriteriaDeviceNetAddress... searchCriteriaDeviceNetAddress)
BWSystem.SystemEndpointGetListRequest	setSearchCriteriaDeviceType(SearchCriteriaDeviceType... searchCriteriaDeviceType)
BWSystem.SystemEndpointGetListRequest	setSearchCriteriaDn(SearchCriteriaDn... searchCriteriaDn)
BWSystem.SystemEndpointGetListRequest	setSearchCriteriaExactOrganizationType(SearchCriteriaExactOrganizationType searchCriteriaExactOrganizationType)
BWSystem.SystemEndpointGetListRequest	setSearchCriteriaExtension(SearchCriteriaExtension... searchCriteriaExtension)
BWSystem.SystemEndpointGetListRequest	setSearchCriteriaGroupId(SearchCriteriaGroupId... searchCriteriaGroupId)
BWSystem.SystemEndpointGetListRequest	setSearchCriteriaLinePortDomain(SearchCriteriaLinePortDomain... searchCriteriaLinePortDomain)
BWSystem.SystemEndpointGetListRequest	setSearchCriteriaLinePortUserPart(SearchCriteriaLinePortUserPart... searchCriteriaLinePortUserPart)
BWSystem.SystemEndpointGetListRequest	setSearchCriteriaResellerId(SearchCriteriaResellerId... searchCriteriaResellerId)
BWSystem.SystemEndpointGetListRequest	setSearchCriteriaServiceProviderId(SearchCriteriaServiceProviderId... searchCriteriaServiceProviderId)
BWSystem.SystemEndpointGetListRequest	setSearchCriteriaUserFirstName(SearchCriteriaUserFirstName... searchCriteriaUserFirstName)
BWSystem.SystemEndpointGetListRequest	setSearchCriteriaUserId(SearchCriteriaUserId... searchCriteriaUserId)
BWSystem.SystemEndpointGetListRequest	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

responseSizeLimit

protected Integer responseSizeLimit

searchCriteriaServiceProviderId

@Valid
protected @Valid SearchCriteriaServiceProviderId[] searchCriteriaServiceProviderId

searchCriteriaExactOrganizationType

@Valid
protected @Valid SearchCriteriaExactOrganizationType searchCriteriaExactOrganizationType

searchCriteriaGroupId

@Valid
protected @Valid SearchCriteriaGroupId[] searchCriteriaGroupId

searchCriteriaLinePortUserPart

@Valid
protected @Valid SearchCriteriaLinePortUserPart[] searchCriteriaLinePortUserPart

searchCriteriaLinePortDomain

@Valid
protected @Valid SearchCriteriaLinePortDomain[] searchCriteriaLinePortDomain

searchCriteriaUserLastName

@Valid
protected @Valid SearchCriteriaUserLastName[] searchCriteriaUserLastName

searchCriteriaUserFirstName

@Valid
protected @Valid SearchCriteriaUserFirstName[] searchCriteriaUserFirstName

searchCriteriaUserId

@Valid
protected @Valid SearchCriteriaUserId[] searchCriteriaUserId

searchCriteriaDn

@Valid
protected @Valid SearchCriteriaDn[] searchCriteriaDn

searchCriteriaExtension

@Valid
protected @Valid SearchCriteriaExtension[] searchCriteriaExtension

searchCriteriaDeviceType

@Valid
protected @Valid SearchCriteriaDeviceType[] searchCriteriaDeviceType

searchCriteriaDeviceName

@Valid
protected @Valid SearchCriteriaDeviceName[] searchCriteriaDeviceName

searchCriteriaDeviceMACAddress

@Valid
protected @Valid SearchCriteriaDeviceMACAddress[] searchCriteriaDeviceMACAddress

searchCriteriaDeviceNetAddress

@Valid
protected @Valid SearchCriteriaDeviceNetAddress[] searchCriteriaDeviceNetAddress

searchCriteriaResellerId

@Valid
protected @Valid SearchCriteriaResellerId[] searchCriteriaResellerId

Constructor Details

SystemEndpointGetListRequest

public SystemEndpointGetListRequest()

SystemEndpointGetListRequest

public SystemEndpointGetListRequest(BroadWorksServer broadWorksServer)

Method Details

setResponseSizeLimit

public BWSystem.SystemEndpointGetListRequest setResponseSizeLimit(Integer responseSizeLimit)

getResponseSizeLimit

public Integer getResponseSizeLimit()

setSearchCriteriaServiceProviderId

public BWSystem.SystemEndpointGetListRequest setSearchCriteriaServiceProviderId(SearchCriteriaServiceProviderId... searchCriteriaServiceProviderId)

getSearchCriteriaServiceProviderId

public SearchCriteriaServiceProviderId[] getSearchCriteriaServiceProviderId()

setSearchCriteriaExactOrganizationType

public BWSystem.SystemEndpointGetListRequest setSearchCriteriaExactOrganizationType(SearchCriteriaExactOrganizationType searchCriteriaExactOrganizationType)

getSearchCriteriaExactOrganizationType

public SearchCriteriaExactOrganizationType getSearchCriteriaExactOrganizationType()

setSearchCriteriaGroupId

public BWSystem.SystemEndpointGetListRequest setSearchCriteriaGroupId(SearchCriteriaGroupId... searchCriteriaGroupId)

getSearchCriteriaGroupId

public SearchCriteriaGroupId[] getSearchCriteriaGroupId()

setSearchCriteriaLinePortUserPart

public BWSystem.SystemEndpointGetListRequest setSearchCriteriaLinePortUserPart(SearchCriteriaLinePortUserPart... searchCriteriaLinePortUserPart)

getSearchCriteriaLinePortUserPart

public SearchCriteriaLinePortUserPart[] getSearchCriteriaLinePortUserPart()

setSearchCriteriaLinePortDomain

public BWSystem.SystemEndpointGetListRequest setSearchCriteriaLinePortDomain(SearchCriteriaLinePortDomain... searchCriteriaLinePortDomain)

getSearchCriteriaLinePortDomain

public SearchCriteriaLinePortDomain[] getSearchCriteriaLinePortDomain()

setSearchCriteriaUserLastName

public BWSystem.SystemEndpointGetListRequest setSearchCriteriaUserLastName(SearchCriteriaUserLastName... searchCriteriaUserLastName)

getSearchCriteriaUserLastName

public SearchCriteriaUserLastName[] getSearchCriteriaUserLastName()

setSearchCriteriaUserFirstName

public BWSystem.SystemEndpointGetListRequest setSearchCriteriaUserFirstName(SearchCriteriaUserFirstName... searchCriteriaUserFirstName)

getSearchCriteriaUserFirstName

public SearchCriteriaUserFirstName[] getSearchCriteriaUserFirstName()

setSearchCriteriaUserId

public BWSystem.SystemEndpointGetListRequest setSearchCriteriaUserId(SearchCriteriaUserId... searchCriteriaUserId)

getSearchCriteriaUserId

public SearchCriteriaUserId[] getSearchCriteriaUserId()

setSearchCriteriaDn

public BWSystem.SystemEndpointGetListRequest setSearchCriteriaDn(SearchCriteriaDn... searchCriteriaDn)

getSearchCriteriaDn

public SearchCriteriaDn[] getSearchCriteriaDn()

setSearchCriteriaExtension

public BWSystem.SystemEndpointGetListRequest setSearchCriteriaExtension(SearchCriteriaExtension... searchCriteriaExtension)

getSearchCriteriaExtension

public SearchCriteriaExtension[] getSearchCriteriaExtension()

setSearchCriteriaDeviceType

public BWSystem.SystemEndpointGetListRequest setSearchCriteriaDeviceType(SearchCriteriaDeviceType... searchCriteriaDeviceType)

getSearchCriteriaDeviceType

public SearchCriteriaDeviceType[] getSearchCriteriaDeviceType()

setSearchCriteriaDeviceName

public BWSystem.SystemEndpointGetListRequest setSearchCriteriaDeviceName(SearchCriteriaDeviceName... searchCriteriaDeviceName)

getSearchCriteriaDeviceName

public SearchCriteriaDeviceName[] getSearchCriteriaDeviceName()

setSearchCriteriaDeviceMACAddress

public BWSystem.SystemEndpointGetListRequest setSearchCriteriaDeviceMACAddress(SearchCriteriaDeviceMACAddress... searchCriteriaDeviceMACAddress)

getSearchCriteriaDeviceMACAddress

public SearchCriteriaDeviceMACAddress[] getSearchCriteriaDeviceMACAddress()

setSearchCriteriaDeviceNetAddress

public BWSystem.SystemEndpointGetListRequest setSearchCriteriaDeviceNetAddress(SearchCriteriaDeviceNetAddress... searchCriteriaDeviceNetAddress)

getSearchCriteriaDeviceNetAddress

public SearchCriteriaDeviceNetAddress[] getSearchCriteriaDeviceNetAddress()

setSearchCriteriaResellerId

public BWSystem.SystemEndpointGetListRequest setSearchCriteriaResellerId(SearchCriteriaResellerId... searchCriteriaResellerId)

getSearchCriteriaResellerId

public SearchCriteriaResellerId[] getSearchCriteriaResellerId()

formRequest

public void formRequest()

Forms the XML Document for this Request Object. Called by the Request upon fire().

Overrides:

formRequest in class Request<BWSystem.SystemEndpointGetListResponse>