org.zimowski.bambi.editor.plugins.api

Class ExportDef

java.lang.Object

org.zimowski.bambi.editor.plugins.api.ExportDef

Direct Known Subclasses:

ImageExportDef

public class ExportDef
extends Object

A simple struct which holds objects defining and handling generic export process.

Author:

Adam Zimowski (mrazjava)

Constructor Summary

Constructors

Constructor and Description
ExportDef()

Method Summary

Methods

Modifier and Type	Method and Description
ExportAbortInformer	getAbortAgent()
String	getLoginId() Login ID authentication token.
String	getPassword() Password authentication token.
ExportProgressMonitor	getProgressMonitor()
List<ExportStateMonitor>	getStateMonitors()
String	getUrl()
void	setAbortAgent(ExportAbortInformer abortAgent)
void	setLoginId(String loginId)
void	setPassword(String password)
void	setProgressMonitor(ExportProgressMonitor progressMonitor)
void	setStateMonitors(List<ExportStateMonitor> stateMonitors)
void	setUrl(String url)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ExportDef

public ExportDef()

Method Detail

getUrl

public String getUrl()

Returns:

destination endpoint receiving the exported data

setUrl

public void setUrl(String url)

Parameters:

url - destination endpoint receiving the exported data

getLoginId

public String getLoginId()

Login ID authentication token. Will be already encrypted if encryption was requested.

Returns:

authentication; may be null if not used

setLoginId

public void setLoginId(String loginId)

Parameters:

loginId - authentication; may be null if not used

getPassword

public String getPassword()

Password authentication token. Will be already encrypted if encryption was requested.

Returns:

authentication; may be null if not used

setPassword

public void setPassword(String password)

Parameters:

password - authentication; may be null if not used

getAbortAgent

public ExportAbortInformer getAbortAgent()

Returns:

agent that can tell if export abort has been requested; null safe

setAbortAgent

public void setAbortAgent(ExportAbortInformer abortAgent)

Parameters:

abortAgent - agent that can tell if export abort has been requested

getProgressMonitor

public ExportProgressMonitor getProgressMonitor()

Returns:

object to which export progress should be reported to; null safe

setProgressMonitor

public void setProgressMonitor(ExportProgressMonitor progressMonitor)

Parameters:

progressMonitor - object to which export progress should be reported to

getStateMonitors

public List<ExportStateMonitor> getStateMonitors()

Returns:

objects to which state of the export should be reported to; null safe

setStateMonitors

public void setStateMonitors(List<ExportStateMonitor> stateMonitors)

Parameters:

stateMonitors - objects to which state of the export should be reported to