Package co.ecg.alpaca.toolkit.generated

Class BWSystem.SystemServiceCodeGetListRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.BWSystem.SystemServiceCodeGetListRequest

Enclosing class:

BWSystem

public static class BWSystem.SystemServiceCodeGetListRequest
extends Request<BWSystem.SystemServiceCodeGetListResponse>

Request to get all service codes that have been defined in the system. 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 SystemServiceCodeGetListResponse or 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 Integer	responseSizeLimit
protected @Valid SearchCriteriaServiceCode[]	searchCriteriaServiceCode
protected @Valid SearchCriteriaServiceCodeDescription[]	searchCriteriaServiceCodeDescription

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

log

Constructor Summary

Constructors

Constructor	Description
SystemServiceCodeGetListRequest()
SystemServiceCodeGetListRequest(BroadWorksServer broadWorksServer)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
Integer	getResponseSizeLimit()
SearchCriteriaServiceCode[]	getSearchCriteriaServiceCode()
SearchCriteriaServiceCodeDescription[]	getSearchCriteriaServiceCodeDescription()
BWSystem.SystemServiceCodeGetListRequest	setResponseSizeLimit(Integer responseSizeLimit)
BWSystem.SystemServiceCodeGetListRequest	setSearchCriteriaServiceCode(SearchCriteriaServiceCode... searchCriteriaServiceCode)
BWSystem.SystemServiceCodeGetListRequest	setSearchCriteriaServiceCodeDescription(SearchCriteriaServiceCodeDescription... searchCriteriaServiceCodeDescription)

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

searchCriteriaServiceCode

@Valid
protected @Valid SearchCriteriaServiceCode[] searchCriteriaServiceCode

searchCriteriaServiceCodeDescription

@Valid
protected @Valid SearchCriteriaServiceCodeDescription[] searchCriteriaServiceCodeDescription

Constructor Details

SystemServiceCodeGetListRequest

public SystemServiceCodeGetListRequest()

SystemServiceCodeGetListRequest

public SystemServiceCodeGetListRequest(BroadWorksServer broadWorksServer)

Method Details

setResponseSizeLimit

public BWSystem.SystemServiceCodeGetListRequest setResponseSizeLimit(Integer responseSizeLimit)

getResponseSizeLimit

public Integer getResponseSizeLimit()

setSearchCriteriaServiceCode

public BWSystem.SystemServiceCodeGetListRequest setSearchCriteriaServiceCode(SearchCriteriaServiceCode... searchCriteriaServiceCode)

getSearchCriteriaServiceCode

public SearchCriteriaServiceCode[] getSearchCriteriaServiceCode()

setSearchCriteriaServiceCodeDescription

public BWSystem.SystemServiceCodeGetListRequest setSearchCriteriaServiceCodeDescription(SearchCriteriaServiceCodeDescription... searchCriteriaServiceCodeDescription)

getSearchCriteriaServiceCodeDescription

public SearchCriteriaServiceCodeDescription[] getSearchCriteriaServiceCodeDescription()

formRequest

public void formRequest()

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

Overrides:

formRequest in class Request<BWSystem.SystemServiceCodeGetListResponse>