ag.ion.bion.officelayer.application.connection
Interface IOfficeConnection

All Known Implementing Classes:

AbstractOfficeConnection, LocalOfficeConnection, RemoteOfficeConnection

public interface IOfficeConnection

Connection in order to communicate with an OpenOffice.org application.

Method Summary

void	addBridgeEventListener(IEventListener eventListener) Adds new listener for the internal XBridge of OpenOffice.org.
void	closeConnection() Closes connection to OpenOffice.org.
java.lang.Object	createService(java.lang.String serviceName) Constructs service with the XMultiServiceFactory.
java.lang.Object	createServiceWithContext(java.lang.String serviceName) Constructs service with the XMultiComponentFactory.
java.lang.String	getHost() Returns host of the connection
java.lang.String	getPort() Returns port of the connection.
com.sun.star.uno.XComponentContext	getXComponentContext() Returns XComponentContext.
com.sun.star.lang.XMultiComponentFactory	getXMultiComponentFactory() Returns XMultiComponentFactory.
com.sun.star.lang.XMultiServiceFactory	getXMultiServiceFactory() Returns XMultiServiceFactory.
boolean	isConnected() Returns information whether the connection is active.
boolean	openConnection() Opens connection to OpenOffice.org.
boolean	openConnection(IOfficeProgressMonitor officeProgressMonitor) Opens connection to OpenOffice.org.

Method Detail

openConnection

boolean openConnection(IOfficeProgressMonitor officeProgressMonitor)
                       throws java.lang.Exception

Opens connection to OpenOffice.org.

Parameters:

officeProgressMonitor - office progress monitor to be used

Returns:

information whether the connection is available

Throws:

java.lang.Exception - if any error occurs

openConnection

boolean openConnection()
                       throws java.lang.Exception

Opens connection to OpenOffice.org.

Returns:

information whether the connection is available

Throws:

java.lang.Exception - if any error occurs

isConnected

boolean isConnected()

Returns information whether the connection is active.

Returns:

information whether the connection is active

closeConnection

void closeConnection()

Closes connection to OpenOffice.org.

getXComponentContext

com.sun.star.uno.XComponentContext getXComponentContext()

Returns XComponentContext.

Returns:

XComponentContext

getXMultiServiceFactory

com.sun.star.lang.XMultiServiceFactory getXMultiServiceFactory()
                                                               throws java.lang.Exception

Returns XMultiServiceFactory.

Returns:

XMultiServiceFactory

Throws:

java.lang.Exception - if anything fails

getXMultiComponentFactory

com.sun.star.lang.XMultiComponentFactory getXMultiComponentFactory()
                                                                   throws java.lang.Exception

Returns XMultiComponentFactory.

Returns:

XMultiComponentFactory

Throws:

java.lang.Exception - if the closed connection could not be opened

getHost

java.lang.String getHost()

Returns host of the connection

Returns:

host of the connection

getPort

java.lang.String getPort()

Returns port of the connection.

Returns:

port of the connection.

createService

java.lang.Object createService(java.lang.String serviceName)
                               throws java.lang.Exception

Constructs service with the XMultiServiceFactory.

Parameters:

serviceName - name of the service

Returns:

service object

Throws:

java.lang.Exception - if any error occurs

createServiceWithContext

java.lang.Object createServiceWithContext(java.lang.String serviceName)
                                          throws java.lang.Exception

Constructs service with the XMultiComponentFactory.

Parameters:

serviceName - name of the service

Returns:

service object

Throws:

java.lang.Exception - if any error occurs

addBridgeEventListener

void addBridgeEventListener(IEventListener eventListener)

Adds new listener for the internal XBridge of OpenOffice.org.

Parameters:

eventListener - new event listener