Package co.ecg.alpaca.toolkit.generated

Class BWSystem.SystemDeviceFamilyAddRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.BWSystem.SystemDeviceFamilyAddRequest

Enclosing class:

BWSystem

public static class BWSystem.SystemDeviceFamilyAddRequest
extends Request<DefaultResponse>

Request to add a device family. When the optional element resellerId is specified, the device family created is at reseller level. Device family name should be unique throughout the system including all the reseller level device families. The response is either a SuccessResponse or an ErrorResponse. The following elements are only used in AS data mode and ignored in the XS data mode: resellerId

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 String[]	assignDeviceType
protected String[]	assignTagSet
protected @NotNull @Size(min=1,max=30) String	deviceFamilyName
protected @Size(min=1,max=36) String	resellerId

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

log

Constructor Summary

Constructors

Constructor	Description
SystemDeviceFamilyAddRequest()
SystemDeviceFamilyAddRequest(BroadWorksServer broadWorksServer, String deviceFamilyName)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
String[]	getAssignDeviceType()
String[]	getAssignTagSet()
String	getDeviceFamilyName()
static BWSystem.SystemDeviceFamilyAddRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
String	getResellerId()
BWSystem.SystemDeviceFamilyAddRequest	setAssignDeviceType(String... assignDeviceType)
BWSystem.SystemDeviceFamilyAddRequest	setAssignTagSet(String... assignTagSet)
BWSystem.SystemDeviceFamilyAddRequest	setDeviceFamilyName(String deviceFamilyName)
BWSystem.SystemDeviceFamilyAddRequest	setResellerId(String resellerId)

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

deviceFamilyName

@NotNull
@Size(min=1,
      max=30)
protected @NotNull @Size(min=1,max=30) String deviceFamilyName

resellerId

@Size(min=1,
      max=36)
protected @Size(min=1,max=36) String resellerId

assignDeviceType

@StringArrayElementSize(min=1,
                        max=40)
protected String[] assignDeviceType

assignTagSet

@StringArrayElementSize(min=1,
                        max=30)
protected String[] assignTagSet

Constructor Details

SystemDeviceFamilyAddRequest

public SystemDeviceFamilyAddRequest()

SystemDeviceFamilyAddRequest

public SystemDeviceFamilyAddRequest(BroadWorksServer broadWorksServer,
 String deviceFamilyName)

Method Details

setDeviceFamilyName

public BWSystem.SystemDeviceFamilyAddRequest setDeviceFamilyName(String deviceFamilyName)

getDeviceFamilyName

public String getDeviceFamilyName()

setResellerId

public BWSystem.SystemDeviceFamilyAddRequest setResellerId(String resellerId)

getResellerId

public String getResellerId()

setAssignDeviceType

public BWSystem.SystemDeviceFamilyAddRequest setAssignDeviceType(String... assignDeviceType)

getAssignDeviceType

public String[] getAssignDeviceType()

setAssignTagSet

public BWSystem.SystemDeviceFamilyAddRequest setAssignTagSet(String... assignTagSet)

getAssignTagSet

public String[] getAssignTagSet()

getEmptyObject

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