com.arcway.cockpit.docgen.provider.interfaces

Interface IRootDataProvider

All Superinterfaces:

com.arcway.cockpit.docgen.provider.IAbstractReportProvider, com.arcway.cockpit.docgen.provider.IPotentionallyProjectRelatedReportProvider, com.arcway.cockpit.docgen.provider.IProjectRelatedReportProvider, com.arcway.cockpit.docgen.provider.IReportRelatedReportProvider

public interface IRootDataProvider
extends com.arcway.cockpit.docgen.provider.IPotentionallyProjectRelatedReportProvider

The IRootDataProvider allows to access to configured cockpit servers and projects for document generation. The IRootDataProvider can be referenced directly within a document template by its name rootDataProvider.

For further elements in the context see IProjectDataProvider

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,IConfiguredProject>	getConfiguredProjects() Returns all currently configured projects.
java.util.Map<java.lang.String,IConfiguredServerConnection>	getConfiguredServerConnections() Returns all currently configured server connections.
boolean	isReaderClient() Determines the client type.

Methods inherited from interface com.arcway.cockpit.docgen.provider.IProjectRelatedReportProvider

setup

Methods inherited from interface com.arcway.cockpit.docgen.provider.IReportRelatedReportProvider

setup

Method Detail

isReaderClient

boolean isReaderClient()

Determines the client type.

Returns:

true if this client is a reader client, false otherwise

getConfiguredServerConnections

java.util.Map<java.lang.String,IConfiguredServerConnection> getConfiguredServerConnections()

Returns all currently configured server connections.

Returns:

map with the server ID as key and the configured server connection as value

getConfiguredProjects

java.util.Map<java.lang.String,IConfiguredProject> getConfiguredProjects()

Returns all currently configured projects.

Returns:

map with project UID as key and the configured project as value