Package co.ecg.alpaca.toolkit.generated

Class BWSystem.SystemDnGetSummaryListRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.BWSystem.SystemDnGetSummaryListRequest

Enclosing class:

BWSystem

public static class BWSystem.SystemDnGetSummaryListRequest
extends Request<BWSystem.SystemDnGetSummaryListResponse>

Request a summary table of all DNs in the system. If resellerId is specified, the DNs assigned to the enterprises/service providers within the reseller are returned. If reseller administrator sends the request and resellerId is not specified, the administrator's resellerId is used. The search can be done using multiple criteria. Only results matching all the search criteria are included in the results. The response is either SystemDnGetSummaryListResponse or ErrorResponse. The following data elements are only used in AS data mode: resellerId The following elements are only used in XS data mode and ignored in AS data mode: searchCriteriaDn, searchCriteriaServiceProviderId, searchCriteriaExactOrganizationType

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 @Size(min=1,max=30) java.lang.String	resellerId
protected @Valid SearchCriteriaDn[]	searchCriteriaDn
protected @Valid SearchCriteriaExactOrganizationType	searchCriteriaExactOrganizationType
protected @Valid SearchCriteriaServiceProviderId[]	searchCriteriaServiceProviderId

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

log

Constructor Summary

Constructors

Constructor	Description
SystemDnGetSummaryListRequest()
SystemDnGetSummaryListRequest(BroadWorksServer broadWorksServer)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
java.lang.String	getResellerId()
SearchCriteriaDn[]	getSearchCriteriaDn()
SearchCriteriaExactOrganizationType	getSearchCriteriaExactOrganizationType()
SearchCriteriaServiceProviderId[]	getSearchCriteriaServiceProviderId()
BWSystem.SystemDnGetSummaryListRequest	setResellerId(java.lang.String resellerId)
BWSystem.SystemDnGetSummaryListRequest	setSearchCriteriaDn(SearchCriteriaDn... searchCriteriaDn)
BWSystem.SystemDnGetSummaryListRequest	setSearchCriteriaExactOrganizationType(SearchCriteriaExactOrganizationType searchCriteriaExactOrganizationType)
BWSystem.SystemDnGetSummaryListRequest	setSearchCriteriaServiceProviderId(SearchCriteriaServiceProviderId... searchCriteriaServiceProviderId)

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, isMemberOfBundle, isValid, setBroadWorksServer, setCommandElement, setCommandType, setDomDocument, setEcho, 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

resellerId

@Size(min=1, max=30) protected @Size(min=1,max=30) java.lang.String resellerId

searchCriteriaDn

@Valid protected @Valid SearchCriteriaDn[] searchCriteriaDn

searchCriteriaServiceProviderId

@Valid protected @Valid SearchCriteriaServiceProviderId[] searchCriteriaServiceProviderId

searchCriteriaExactOrganizationType

@Valid protected @Valid SearchCriteriaExactOrganizationType searchCriteriaExactOrganizationType

Constructor Details

SystemDnGetSummaryListRequest

public SystemDnGetSummaryListRequest()

SystemDnGetSummaryListRequest

public SystemDnGetSummaryListRequest(BroadWorksServer broadWorksServer)

Method Details

setResellerId

public BWSystem.SystemDnGetSummaryListRequest setResellerId(java.lang.String resellerId)

getResellerId

public java.lang.String getResellerId()

setSearchCriteriaDn

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

getSearchCriteriaDn

public SearchCriteriaDn[] getSearchCriteriaDn()

setSearchCriteriaServiceProviderId

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

getSearchCriteriaServiceProviderId

public SearchCriteriaServiceProviderId[] getSearchCriteriaServiceProviderId()

setSearchCriteriaExactOrganizationType

public BWSystem.SystemDnGetSummaryListRequest setSearchCriteriaExactOrganizationType(SearchCriteriaExactOrganizationType searchCriteriaExactOrganizationType)

getSearchCriteriaExactOrganizationType

public SearchCriteriaExactOrganizationType getSearchCriteriaExactOrganizationType()

formRequest

public void formRequest()

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

Overrides:

formRequest in class Request<BWSystem.SystemDnGetSummaryListResponse>