co.ecg.alpaca.toolkit.generated

Class BWSystem.SystemOfficeZoneAddRequest

java.lang.Object

co.ecg.alpaca.toolkit.messaging.request.Request<DefaultResponse>

co.ecg.alpaca.toolkit.generated.BWSystem.SystemOfficeZoneAddRequest

All Implemented Interfaces:

Runnable

Enclosing class:

BWSystem

@GwtIncompatible
public static class BWSystem.SystemOfficeZoneAddRequest
extends Request<DefaultResponse>

AlpacaLibrary Auto-Generated Java File Add a new Office Zone. The zoneList is an ordered list with the first member being of the highest priority. The response is either a SuccessResponse or an ErrorResponse.

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 and Description
protected String	description
protected String	officeZoneName
protected String	primaryZoneName
protected String[]	zoneName

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

log

Constructor Summary

Constructors

Constructor and Description
SystemOfficeZoneAddRequest(BroadWorksServer broadWorksServer, String officeZoneName, String primaryZoneName, String... zoneName)

Method Summary

Modifier and Type	Method and Description
void	formRequest() Forms the XML Document for this Request Object.
String	getDescription()
static BWSystem.SystemOfficeZoneAddRequest	getEmptyObject(BroadWorksServer broadWorksServer) Retrieves this object with minimal setup.
String	getOfficeZoneName()
String	getPrimaryZoneName()
String[]	getZoneName()
BWSystem.SystemOfficeZoneAddRequest	setDescription(String description)
BWSystem.SystemOfficeZoneAddRequest	setOfficeZoneName(String officeZoneName)
BWSystem.SystemOfficeZoneAddRequest	setPrimaryZoneName(String primaryZoneName)
BWSystem.SystemOfficeZoneAddRequest	setZoneName(String... zoneName)

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

appendChild, appendChild, appendChild, asyncFire, createDocument, createElement, createNilElement, createTextElement, fire, fire, getBroadWorksServer, getCommandElement, getCommandType, getDomDocument, getId, getResponseClass, getRootElement, isMemberOfBundle, isValid, run, setBroadWorksServer, setCommandElement, setCommandType, setDomDocument, setMemberOfBundle, setRequestId, setResponseClass, setRootElement, toString, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

officeZoneName

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

description

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

zoneName

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

primaryZoneName

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

Constructor Detail

SystemOfficeZoneAddRequest

public SystemOfficeZoneAddRequest(BroadWorksServer broadWorksServer,
                                  String officeZoneName,
                                  String primaryZoneName,
                                  String... zoneName)

Method Detail

setOfficeZoneName

public BWSystem.SystemOfficeZoneAddRequest setOfficeZoneName(String officeZoneName)

getOfficeZoneName

public String getOfficeZoneName()

setDescription

public BWSystem.SystemOfficeZoneAddRequest setDescription(String description)

getDescription

public String getDescription()

setZoneName

public BWSystem.SystemOfficeZoneAddRequest setZoneName(String... zoneName)

getZoneName

public String[] getZoneName()

setPrimaryZoneName

public BWSystem.SystemOfficeZoneAddRequest setPrimaryZoneName(String primaryZoneName)

getPrimaryZoneName

public String getPrimaryZoneName()

getEmptyObject

public static BWSystem.SystemOfficeZoneAddRequest 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<DefaultResponse>