Package co.ecg.alpaca.toolkit.generated

Class BWSystem.SystemZoneLocationBasedPhysicalLocationGetListRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.BWSystem.SystemZoneLocationBasedPhysicalLocationGetListRequest

Enclosing class:

BWSystem

public static class BWSystem.SystemZoneLocationBasedPhysicalLocationGetListRequest
extends Request<BWSystem.SystemZoneLocationBasedPhysicalLocationGetListResponse>

Gets a list of physical locations assigned to a zone. Response is SystemZoneLocationBasedPhysicalLocationGetListResponse or an 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 SearchCriteriaPhysicalLocation[]	searchCriteriaPhysicalLocation
protected @NotNull @Size(min=1,max=80) String	zoneName

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

log

Constructor Summary

Constructors

Constructor	Description
SystemZoneLocationBasedPhysicalLocationGetListRequest()
SystemZoneLocationBasedPhysicalLocationGetListRequest(BroadWorksServer broadWorksServer, String zoneName)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
static BWSystem.SystemZoneLocationBasedPhysicalLocationGetListRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
Integer	getResponseSizeLimit()
SearchCriteriaPhysicalLocation[]	getSearchCriteriaPhysicalLocation()
String	getZoneName()
BWSystem.SystemZoneLocationBasedPhysicalLocationGetListRequest	setResponseSizeLimit(Integer responseSizeLimit)
BWSystem.SystemZoneLocationBasedPhysicalLocationGetListRequest	setSearchCriteriaPhysicalLocation(SearchCriteriaPhysicalLocation... searchCriteriaPhysicalLocation)
BWSystem.SystemZoneLocationBasedPhysicalLocationGetListRequest	setZoneName(String zoneName)

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 Detail

zoneName

@NotNull
@Size(min=1,
      max=80)
protected @NotNull @Size(min=1,max=80) String zoneName

responseSizeLimit

protected Integer responseSizeLimit

searchCriteriaPhysicalLocation

@Valid
protected @Valid SearchCriteriaPhysicalLocation[] searchCriteriaPhysicalLocation

Constructor Detail

SystemZoneLocationBasedPhysicalLocationGetListRequest

public SystemZoneLocationBasedPhysicalLocationGetListRequest()

SystemZoneLocationBasedPhysicalLocationGetListRequest

public SystemZoneLocationBasedPhysicalLocationGetListRequest(BroadWorksServer broadWorksServer,
                                                             String zoneName)

Method Detail

setZoneName

public BWSystem.SystemZoneLocationBasedPhysicalLocationGetListRequest setZoneName(String zoneName)

getZoneName

public String getZoneName()

setResponseSizeLimit

public BWSystem.SystemZoneLocationBasedPhysicalLocationGetListRequest setResponseSizeLimit(Integer responseSizeLimit)

getResponseSizeLimit

public Integer getResponseSizeLimit()

setSearchCriteriaPhysicalLocation

public BWSystem.SystemZoneLocationBasedPhysicalLocationGetListRequest setSearchCriteriaPhysicalLocation(SearchCriteriaPhysicalLocation... searchCriteriaPhysicalLocation)

getSearchCriteriaPhysicalLocation

public SearchCriteriaPhysicalLocation[] getSearchCriteriaPhysicalLocation()

getEmptyObject

public static BWSystem.SystemZoneLocationBasedPhysicalLocationGetListRequest 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<BWSystem.SystemZoneLocationBasedPhysicalLocationGetListResponse>