co.ecg.alpaca.toolkit.generated

Class BWSystem.SystemExportAddressingDataRequest

java.lang.Object

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

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

All Implemented Interfaces:

Runnable

Enclosing class:

BWSystem

public static class BWSystem.SystemExportAddressingDataRequest
extends Request<Response.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. The response is either a SuccessResponse or an ErrorResponse.

Field Summary

Fields

Modifier and Type	Field and Description
String	fileName
boolean	fileNameIsModified

Constructor Summary

Constructors

Constructor and Description
SystemExportAddressingDataRequest(BroadWorksServer bws) Default Constructor -- Not Guaranteed to work without checking Request validity with isValid()
SystemExportAddressingDataRequest(BroadWorksServer bws, String fileName)

Method Summary

Modifier and Type	Method and Description
void	formRequest() Forms the XML Document for this Request Object.
String	getFileName()
BWSystem.SystemExportAddressingDataRequest	setFileName(String fileName)

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

fileName

@Size(min=1)
public String fileName

fileNameIsModified

public transient boolean fileNameIsModified

Constructor Detail

SystemExportAddressingDataRequest

public SystemExportAddressingDataRequest(BroadWorksServer bws,
                                         String fileName)

SystemExportAddressingDataRequest

public SystemExportAddressingDataRequest(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

setFileName

public BWSystem.SystemExportAddressingDataRequest setFileName(String fileName)

getFileName

public String getFileName()

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