com.arcway.cockpit.genericmodule.reportdesignermodule.docgen.provider.interfaces

Interface ICrossModuleLinkReportDataProvider

public interface ICrossModuleLinkReportDataProvider

The ICrossModuleLinkReportDataProvider allows to access related items from other modules.
The ICrossModuleLinkReportDataProvider can be referenced directly within a document template by its name reportCrossLinkProvider.

Method Summary

Modifier and Type	Method and Description
java.util.Collection<IReport>	getDerivedReports(com.arcway.cockpit.genericmodule.docgen.provider.interfaces.IGenericModuleData underlyingPublicationType) Returns the derived report items.
java.util.Collection<IReport>	getDerivedReportsWithCategory(com.arcway.cockpit.genericmodule.docgen.provider.interfaces.IGenericModuleData underlyingPublicationType, java.lang.String categoryID) Returns the derived report items that belong to the specified category.
java.util.Collection<IReport>	getDerivedReportsWithDefaultCategory(com.arcway.cockpit.genericmodule.docgen.provider.interfaces.IGenericModuleData underlyingPublicationType) Returns the derived report items that belong to the default category.
ITypeofPublication	getImplementedPublicationType(com.arcway.cockpit.genericmodule.docgen.provider.interfaces.IGenericModuleData implementingReport) Returns the implemented publication type item.
IReport	getImplementingReport(com.arcway.cockpit.genericmodule.docgen.provider.interfaces.IGenericModuleData implementedPublicationType) Returns the implementing report item.
ITypeofPublication	getUnderlyingPublicationType(com.arcway.cockpit.genericmodule.docgen.provider.interfaces.IGenericModuleData derivedReport) Returns the underlying publication type item.

Method Detail

getImplementingReport

IReport getImplementingReport(com.arcway.cockpit.genericmodule.docgen.provider.interfaces.IGenericModuleData implementedPublicationType)

Returns the implementing report item.

Parameters:

implementedPublicationType - the implemented publication type

Returns:

the implementing report item or null if none is linked

getImplementedPublicationType

ITypeofPublication getImplementedPublicationType(com.arcway.cockpit.genericmodule.docgen.provider.interfaces.IGenericModuleData implementingReport)

Returns the implemented publication type item.

Parameters:

implementingReport - the implementing report

Returns:

the implemented publication type item or null if none is linked

getDerivedReports

java.util.Collection<IReport> getDerivedReports(com.arcway.cockpit.genericmodule.docgen.provider.interfaces.IGenericModuleData underlyingPublicationType)

Returns the derived report items.

Parameters:

underlyingPublicationType - the underlying publication type

Returns:

the derived report items

getDerivedReportsWithCategory

java.util.Collection<IReport> getDerivedReportsWithCategory(com.arcway.cockpit.genericmodule.docgen.provider.interfaces.IGenericModuleData underlyingPublicationType,
                                                            java.lang.String categoryID)

Returns the derived report items that belong to the specified category.

Parameters:

underlyingPublicationType - the underlying publication type

categoryID - the category ID

Returns:

the derived report items

getDerivedReportsWithDefaultCategory

java.util.Collection<IReport> getDerivedReportsWithDefaultCategory(com.arcway.cockpit.genericmodule.docgen.provider.interfaces.IGenericModuleData underlyingPublicationType)

Returns the derived report items that belong to the default category.

Parameters:

underlyingPublicationType - the underlying publication type

Returns:

the derived report items

getUnderlyingPublicationType

ITypeofPublication getUnderlyingPublicationType(com.arcway.cockpit.genericmodule.docgen.provider.interfaces.IGenericModuleData derivedReport)

Returns the underlying publication type item.

Parameters:

derivedReport - the derived report

Returns:

the underlying publication type item or null if none is linked