Package co.ecg.alpaca.toolkit.generated

Class BWSystem.SystemOfficeZoneGetRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.BWSystem.SystemOfficeZoneGetRequest

Enclosing class:

BWSystem

public static class BWSystem.SystemOfficeZoneGetRequest
extends Request<BWSystem.SystemOfficeZoneGetResponse>

Get an existing Office Zone. The response is either a SystemOfficeZoneGetResponse 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 @NotNull @Size(min=1,max=40) String	officeZoneName

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

log

Constructor Summary

Constructors

Constructor	Description
SystemOfficeZoneGetRequest()
SystemOfficeZoneGetRequest(BroadWorksServer broadWorksServer, String officeZoneName)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
static BWSystem.SystemOfficeZoneGetRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
String	getOfficeZoneName()
BWSystem.SystemOfficeZoneGetRequest	setOfficeZoneName(String officeZoneName)

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

officeZoneName

@NotNull
@Size(min=1,
      max=40)
protected @NotNull @Size(min=1,max=40) String officeZoneName

Constructor Detail

SystemOfficeZoneGetRequest

public SystemOfficeZoneGetRequest()

SystemOfficeZoneGetRequest

public SystemOfficeZoneGetRequest(BroadWorksServer broadWorksServer,
                                  String officeZoneName)

Method Detail

setOfficeZoneName

public BWSystem.SystemOfficeZoneGetRequest setOfficeZoneName(String officeZoneName)

getOfficeZoneName

public String getOfficeZoneName()

getEmptyObject

public static BWSystem.SystemOfficeZoneGetRequest 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.SystemOfficeZoneGetResponse>