Package co.ecg.alpaca.toolkit.generated

Class BWSystem.SystemDomainGetListRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.BWSystem.SystemDomainGetListRequest

Enclosing class:

BWSystem

@Choice(minOccurs=0,value={@ChoiceGroup("excludeReseller"),@ChoiceGroup("resellerId")})
public static class BWSystem.SystemDomainGetListRequest
extends Request<BWSystem.SystemDomainGetListResponse>

Requests the list of all matching system-level domains and all matching reseller level domains. If excludeReseller is specified, returns all matching system-level domain names only. If resellerId is specified, returns all matching system-level domain names and the given reseller's domains. If reseller administrator sends the request and resellerId is not specified, the administrator's resellerId is used. The response is either SystemDomainGetListResponse22V2 or ErrorResponse. The following elements are only used in AS data mode and will be ingored in XS data mode: includeReseller resellerId responseSizeLimit searchCriteriaDomainName searchCriteriaResellerId searchCriteriaExactDomainLevel

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 @AssertTrue Boolean	excludeReseller
protected @Size(min=1,max=36) String	resellerId
protected Integer	responseSizeLimit
protected @Valid SearchCriteriaDomainName[]	searchCriteriaDomainName
protected @Valid SearchCriteriaExactDomainLevel	searchCriteriaExactDomainLevel
protected @Valid SearchCriteriaResellerId[]	searchCriteriaResellerId

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

log

Constructor Summary

Constructors

Constructor	Description
SystemDomainGetListRequest()
SystemDomainGetListRequest(BroadWorksServer broadWorksServer)

Method Summary

Modifier and Type	Method	Description
boolean	excludeResellerFlagExist()
void	formRequest()	Forms the XML Document for this Request Object.
Boolean	getExcludeReseller()
String	getResellerId()
Integer	getResponseSizeLimit()
SearchCriteriaDomainName[]	getSearchCriteriaDomainName()
SearchCriteriaExactDomainLevel	getSearchCriteriaExactDomainLevel()
SearchCriteriaResellerId[]	getSearchCriteriaResellerId()
BWSystem.SystemDomainGetListRequest	setFlagExcludeReseller()
BWSystem.SystemDomainGetListRequest	setResellerId(String resellerId)
BWSystem.SystemDomainGetListRequest	setResponseSizeLimit(Integer responseSizeLimit)
BWSystem.SystemDomainGetListRequest	setSearchCriteriaDomainName(SearchCriteriaDomainName... searchCriteriaDomainName)
BWSystem.SystemDomainGetListRequest	setSearchCriteriaExactDomainLevel(SearchCriteriaExactDomainLevel searchCriteriaExactDomainLevel)
BWSystem.SystemDomainGetListRequest	setSearchCriteriaResellerId(SearchCriteriaResellerId... searchCriteriaResellerId)

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

excludeReseller

@AssertTrue
protected @AssertTrue Boolean excludeReseller

resellerId

@Size(min=1,
      max=36)
protected @Size(min=1,max=36) String resellerId

responseSizeLimit

protected Integer responseSizeLimit

searchCriteriaDomainName

@Valid
protected @Valid SearchCriteriaDomainName[] searchCriteriaDomainName

searchCriteriaResellerId

@Valid
protected @Valid SearchCriteriaResellerId[] searchCriteriaResellerId

searchCriteriaExactDomainLevel

@Valid
protected @Valid SearchCriteriaExactDomainLevel searchCriteriaExactDomainLevel

Constructor Details

SystemDomainGetListRequest

public SystemDomainGetListRequest()

SystemDomainGetListRequest

public SystemDomainGetListRequest(BroadWorksServer broadWorksServer)

Method Details

setFlagExcludeReseller

public BWSystem.SystemDomainGetListRequest setFlagExcludeReseller()

excludeResellerFlagExist

public boolean excludeResellerFlagExist()

getExcludeReseller

public Boolean getExcludeReseller()

setResellerId

public BWSystem.SystemDomainGetListRequest setResellerId(String resellerId)

getResellerId

public String getResellerId()

setResponseSizeLimit

public BWSystem.SystemDomainGetListRequest setResponseSizeLimit(Integer responseSizeLimit)

getResponseSizeLimit

public Integer getResponseSizeLimit()

setSearchCriteriaDomainName

public BWSystem.SystemDomainGetListRequest setSearchCriteriaDomainName(SearchCriteriaDomainName... searchCriteriaDomainName)

getSearchCriteriaDomainName

public SearchCriteriaDomainName[] getSearchCriteriaDomainName()

setSearchCriteriaResellerId

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

getSearchCriteriaResellerId

public SearchCriteriaResellerId[] getSearchCriteriaResellerId()

setSearchCriteriaExactDomainLevel

public BWSystem.SystemDomainGetListRequest setSearchCriteriaExactDomainLevel(SearchCriteriaExactDomainLevel searchCriteriaExactDomainLevel)

getSearchCriteriaExactDomainLevel

public SearchCriteriaExactDomainLevel getSearchCriteriaExactDomainLevel()

formRequest

public void formRequest()

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

Overrides:

formRequest in class Request<BWSystem.SystemDomainGetListResponse>