co.ecg.alpaca.toolkit.generated

Class BWSystem.SystemOfficeZoneAddRequest

java.lang.Object

co.ecg.alpaca.toolkit.Request<Response.DefaultResponse>

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

All Implemented Interfaces:

Runnable

Enclosing class:

BWSystem

public static class BWSystem.SystemOfficeZoneAddRequest
extends Request<Response.DefaultResponse>

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.

Field Summary

Fields

Modifier and Type	Field and Description
String	description
boolean	descriptionIsModified
String	officeZoneName
boolean	officeZoneNameIsModified
String	primaryZoneName
boolean	primaryZoneNameIsModified
String[]	zoneName
boolean	zoneNameIsModified

Constructor Summary

Constructors

Constructor and Description
SystemOfficeZoneAddRequest(BroadWorksServer bws) Default Constructor -- Not Guaranteed to work without checking Request validity with isValid()
SystemOfficeZoneAddRequest(BroadWorksServer bws, 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()
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.Request

appendChild, appendChild, appendChild, asyncFire, createElement, createNilElement, createTextElement, fire, fire, getBroadWorksServer, getCommandType, getDomDocument, getResponseClass, 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

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

officeZoneNameIsModified

public transient boolean officeZoneNameIsModified

description

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

descriptionIsModified

public transient boolean descriptionIsModified

zoneName

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

zoneNameIsModified

public transient boolean zoneNameIsModified

primaryZoneName

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

primaryZoneNameIsModified

public transient boolean primaryZoneNameIsModified

Constructor Detail

SystemOfficeZoneAddRequest

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

SystemOfficeZoneAddRequest

public SystemOfficeZoneAddRequest(BroadWorksServer bws)

Default Constructor -- Not Guaranteed to work without checking Request validity with isValid()

Parameters:

bws - The BroadWorksServer to use for the Request

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()

formRequest

public void formRequest()
                 throws RequestException

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

Specified by:

formRequest in class Request<Response.DefaultResponse>

Throws:

RequestException