ag.ion.bion.officelayer.application
Interface IOfficeApplication

All Superinterfaces:

IDisposeable

All Known Implementing Classes:

AbstractOfficeApplication, LocalOfficeApplication, RemoteOfficeApplication

public interface IOfficeApplication
extends IDisposeable

OpenOffice.org application.

Field Summary

static java.lang.String	APPLICATION_HOME_KEY Configuration key for the application home path (only for local applications).
static java.lang.String	APPLICATION_HOST_KEY Configuration key for the application host (only for remote applications).
static java.lang.String	APPLICATION_PORT_KEY Configuration key for the application port (only for remote applications).
static java.lang.String	APPLICATION_TYPE_KEY Configuration key for the application type.
static java.lang.String	LOCAL_APPLICATION Configuration value for a local application.
static java.lang.String	REMOTE_APPLICATION Configuration value for a remote application.

Method Summary

void	activate() Activates office application.
void	activate(IOfficeProgressMonitor officeProgressMonitor) Activates office application.
void	deactivate() Deactivates the office application.
java.lang.String	getApplicationType() Returns the application type.
IDesktopService	getDesktopService() Returns desktop service of the application.
IDocumentService	getDocumentService() Returns document service.
IServiceProvider	getServiceProvider() Returns service provider.
boolean	isActive() Returns information whether the office application is active or not.
boolean	isConfigured() Returns information whether the office application is configured or not.
void	setConfiguration(IOfficeApplicationConfiguration officeApplicationConfiguration) Deprecated. Use setConfiguration(Map configuration) instead.
void	setConfiguration(java.util.Map configuration) Sets configuration of the office application.

Methods inherited from interface ag.ion.bion.officelayer.IDisposeable

dispose

Field Detail

APPLICATION_TYPE_KEY

static final java.lang.String APPLICATION_TYPE_KEY

Configuration key for the application type.

See Also:

Constant Field Values

APPLICATION_HOST_KEY

static final java.lang.String APPLICATION_HOST_KEY

Configuration key for the application host (only for remote applications).

See Also:

Constant Field Values

APPLICATION_PORT_KEY

static final java.lang.String APPLICATION_PORT_KEY

Configuration key for the application port (only for remote applications).

See Also:

Constant Field Values

APPLICATION_HOME_KEY

static final java.lang.String APPLICATION_HOME_KEY

Configuration key for the application home path (only for local applications).

See Also:

Constant Field Values

REMOTE_APPLICATION

static final java.lang.String REMOTE_APPLICATION

Configuration value for a remote application.

See Also:

Constant Field Values

LOCAL_APPLICATION

static final java.lang.String LOCAL_APPLICATION

Configuration value for a local application.

See Also:

Constant Field Values

Method Detail

setConfiguration

void setConfiguration(IOfficeApplicationConfiguration officeApplicationConfiguration)
                      throws OfficeApplicationException

Deprecated. Use setConfiguration(Map configuration) instead.

Sets configuration of the office application.

Parameters:

officeApplicationConfiguration - configuration of the office application

Throws:

OfficeApplicationException - if the submitted configuration is not valid

setConfiguration

void setConfiguration(java.util.Map configuration)
                      throws OfficeApplicationException

Sets configuration of the office application.

Parameters:

configuration - configuration map to be used

Throws:

OfficeApplicationException - if the configuration is not complete

isConfigured

boolean isConfigured()

Returns information whether the office application is configured or not.

Returns:

true, if the office application is configured

activate

void activate()
              throws OfficeApplicationException

Activates office application.

Throws:

OfficeApplicationException - if the office application can not be activated

activate

void activate(IOfficeProgressMonitor officeProgressMonitor)
              throws OfficeApplicationException

Activates office application.

Parameters:

officeProgressMonitor - office progress monitor to be used

Throws:

OfficeApplicationException - if the office application can not be activated

deactivate

void deactivate()
                throws OfficeApplicationException

Deactivates the office application. This call will not terminate the OpenOffice.org process - it will only dispose the internal communication bridge to OpenOffice.org.

Throws:

OfficeApplicationException - if the office application can not be deactivated

isActive

boolean isActive()

Returns information whether the office application is active or not. This information is not an indicator for a running native OpenOffice.org process.

Returns:

whether the office application is active or not

getDocumentService

IDocumentService getDocumentService()
                                    throws OfficeApplicationException

Returns document service. Return null if the office application is not running.

Returns:

document service or null if the office application is not running

Throws:

OfficeApplicationException - if the document service is not available

getDesktopService

IDesktopService getDesktopService()
                                  throws OfficeApplicationException

Returns desktop service of the application.

Returns:

desktop service of the application

Throws:

OfficeApplicationException - if the desktop service is not available

getApplicationType

java.lang.String getApplicationType()

Returns the application type.

Returns:

application type

getServiceProvider

IServiceProvider getServiceProvider()

Returns service provider. Returns null if the application is not active.

Returns:

service provider null if the application is not active