Package co.ecg.alpaca.toolkit.generated

Class BWSystem.SystemZoneAddRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.BWSystem.SystemZoneAddRequest

Enclosing class:

BWSystem

public static class BWSystem.SystemZoneAddRequest
extends Request<DefaultResponse>

Add a Zone and optional Net Addresses and Physical Locations. The response is either a SuccessResponse 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 @Size(min=1,max=1024) String	callingZonePhysicalLocation
protected String[]	locationBasedPhysicalLocation
protected String[]	netAddress
protected @Valid IPAddressRange[]	netAddressRange
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
SystemZoneAddRequest()
SystemZoneAddRequest(BroadWorksServer broadWorksServer, String zoneName)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
String	getCallingZonePhysicalLocation()
static BWSystem.SystemZoneAddRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
String[]	getLocationBasedPhysicalLocation()
String[]	getNetAddress()
IPAddressRange[]	getNetAddressRange()
String	getZoneName()
BWSystem.SystemZoneAddRequest	setCallingZonePhysicalLocation(String callingZonePhysicalLocation)
BWSystem.SystemZoneAddRequest	setLocationBasedPhysicalLocation(String... locationBasedPhysicalLocation)
BWSystem.SystemZoneAddRequest	setNetAddress(String... netAddress)
BWSystem.SystemZoneAddRequest	setNetAddressRange(IPAddressRange... netAddressRange)
BWSystem.SystemZoneAddRequest	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 Details

zoneName

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

netAddress

@StringArrayElementSize(min=1,
                        max=39)
protected String[] netAddress

netAddressRange

@Valid
protected @Valid IPAddressRange[] netAddressRange

locationBasedPhysicalLocation

@StringArrayElementSize(min=1,
                        max=1024)
protected String[] locationBasedPhysicalLocation

callingZonePhysicalLocation

@Size(min=1,
      max=1024)
protected @Size(min=1,max=1024) String callingZonePhysicalLocation

Constructor Details

SystemZoneAddRequest

public SystemZoneAddRequest()

SystemZoneAddRequest

public SystemZoneAddRequest(BroadWorksServer broadWorksServer,
 String zoneName)

Method Details

setZoneName

public BWSystem.SystemZoneAddRequest setZoneName(String zoneName)

getZoneName

public String getZoneName()

setNetAddress

public BWSystem.SystemZoneAddRequest setNetAddress(String... netAddress)

getNetAddress

public String[] getNetAddress()

setNetAddressRange

public BWSystem.SystemZoneAddRequest setNetAddressRange(IPAddressRange... netAddressRange)

getNetAddressRange

public IPAddressRange[] getNetAddressRange()

setLocationBasedPhysicalLocation

public BWSystem.SystemZoneAddRequest setLocationBasedPhysicalLocation(String... locationBasedPhysicalLocation)

getLocationBasedPhysicalLocation

public String[] getLocationBasedPhysicalLocation()

setCallingZonePhysicalLocation

public BWSystem.SystemZoneAddRequest setCallingZonePhysicalLocation(String callingZonePhysicalLocation)

getCallingZonePhysicalLocation

public String getCallingZonePhysicalLocation()

getEmptyObject

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