Package co.ecg.alpaca.toolkit.generated

Class BWSystem.SystemExportAddressingDataRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.BWSystem.SystemExportAddressingDataRequest

Enclosing class:

BWSystem

public static class BWSystem.SystemExportAddressingDataRequest
extends Request<DefaultResponse>

Request to export Application Server addressing data, such as DNs, extensions, alias and user ids to a file so they can be uploaded to a Network Server. In XS data mode, response is sent without waiting for completion. 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 @NotNull @Size(min=1) String	fileName

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

log

Constructor Summary

Constructors

Constructor	Description
SystemExportAddressingDataRequest()
SystemExportAddressingDataRequest(BroadWorksServer broadWorksServer, String fileName)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
static BWSystem.SystemExportAddressingDataRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
String	getFileName()
BWSystem.SystemExportAddressingDataRequest	setFileName(String fileName)

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

fileName

@NotNull
@Size(min=1)
protected @NotNull @Size(min=1) String fileName

Constructor Details

SystemExportAddressingDataRequest

public SystemExportAddressingDataRequest()

SystemExportAddressingDataRequest

public SystemExportAddressingDataRequest(BroadWorksServer broadWorksServer,
 String fileName)

Method Details

setFileName

public BWSystem.SystemExportAddressingDataRequest setFileName(String fileName)

getFileName

public String getFileName()

getEmptyObject

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