Package co.ecg.alpaca.toolkit.generated

Class BWSystem.SystemDeviceFamilyImportDryRunRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.BWSystem.SystemDeviceFamilyImportDryRunRequest

Enclosing class:

BWSystem

public static class BWSystem.SystemDeviceFamilyImportDryRunRequest
extends Request<BWSystem.SystemDeviceFamilyImportDryRunResponse>

Request to perform a dry run import of a Device Family Set Archive File (DFAF) as a new Device Family. The URL supports the HTTP and the FILE protocols. When the optional element resellerId is specified, the device type created is at reseller level. When the optional element deviceFamilyOverride is set to true, an existing device family with the same name on the destination system will be overridden. When the optional element tagSetOverride is set to true, any existing tag set on the destination system will be overridden. When the optional element deviceTypeFileUpdate is set, on import, for any existing device type associated with the device family, the files that are matched based on the file format are updated with the ones from the DTAF. The file format and the file category are the only attributes that can't be updated. The response is either a SystemDeviceFamilyImportDryRunResponse or an ErrorResponse. The following data elements are only used in AS data mode and ignored in 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 Boolean	deviceFamilyOverride
protected Boolean	deviceTypeFileUpdate
protected @NotNull @Size(min=1,max=256) String	file
protected @Size(min=1,max=36) String	resellerId
protected Boolean	tagSetOverride

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

log

Constructor Summary

Constructors

Constructor	Description
SystemDeviceFamilyImportDryRunRequest()
SystemDeviceFamilyImportDryRunRequest(BroadWorksServer broadWorksServer, String file)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
Boolean	getDeviceFamilyOverride()
Boolean	getDeviceTypeFileUpdate()
static BWSystem.SystemDeviceFamilyImportDryRunRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
String	getFile()
String	getResellerId()
Boolean	getTagSetOverride()
BWSystem.SystemDeviceFamilyImportDryRunRequest	setDeviceFamilyOverride(Boolean deviceFamilyOverride)
BWSystem.SystemDeviceFamilyImportDryRunRequest	setDeviceTypeFileUpdate(Boolean deviceTypeFileUpdate)
BWSystem.SystemDeviceFamilyImportDryRunRequest	setFile(String file)
BWSystem.SystemDeviceFamilyImportDryRunRequest	setResellerId(String resellerId)
BWSystem.SystemDeviceFamilyImportDryRunRequest	setTagSetOverride(Boolean tagSetOverride)

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

file

@NotNull
@Size(min=1,
      max=256)
protected @NotNull @Size(min=1,max=256) String file

resellerId

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

deviceFamilyOverride

protected Boolean deviceFamilyOverride

tagSetOverride

protected Boolean tagSetOverride

deviceTypeFileUpdate

protected Boolean deviceTypeFileUpdate

Constructor Details

SystemDeviceFamilyImportDryRunRequest

public SystemDeviceFamilyImportDryRunRequest()

SystemDeviceFamilyImportDryRunRequest

public SystemDeviceFamilyImportDryRunRequest(BroadWorksServer broadWorksServer,
 String file)

Method Details

setFile

public BWSystem.SystemDeviceFamilyImportDryRunRequest setFile(String file)

getFile

public String getFile()

setResellerId

public BWSystem.SystemDeviceFamilyImportDryRunRequest setResellerId(String resellerId)

getResellerId

public String getResellerId()

setDeviceFamilyOverride

public BWSystem.SystemDeviceFamilyImportDryRunRequest setDeviceFamilyOverride(Boolean deviceFamilyOverride)

getDeviceFamilyOverride

public Boolean getDeviceFamilyOverride()

setTagSetOverride

public BWSystem.SystemDeviceFamilyImportDryRunRequest setTagSetOverride(Boolean tagSetOverride)

getTagSetOverride

public Boolean getTagSetOverride()

setDeviceTypeFileUpdate

public BWSystem.SystemDeviceFamilyImportDryRunRequest setDeviceTypeFileUpdate(Boolean deviceTypeFileUpdate)

getDeviceTypeFileUpdate

public Boolean getDeviceTypeFileUpdate()

getEmptyObject

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