com.arcway.cockpit.genericmodule.documentcontentmodule.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 documentContentLinkReportProvider.

Method Summary

Modifier and Type	Method and Description
java.util.Collection<ICrossReference>	getCrossReferences(com.arcway.cockpit.modulelib2.client.docgen.provider.interfaces.IModuleData referenceTarget) Returns the cross reference items.
java.util.Collection<ICrossReference>	getCrossReferencesWithCategory(com.arcway.cockpit.modulelib2.client.docgen.provider.interfaces.IModuleData referenceTarget, java.lang.String categoryID) Returns the cross reference items that belong to the specified category.
java.util.Collection<ICrossReference>	getCrossReferencesWithDefaultCategory(com.arcway.cockpit.modulelib2.client.docgen.provider.interfaces.IModuleData referenceTarget) Returns the cross reference items that belong to the default category.
com.arcway.cockpit.modulelib2.client.docgen.provider.interfaces.IModuleData	getReferenceTarget(com.arcway.cockpit.genericmodule.docgen.provider.interfaces.IGenericModuleData crossReference) Returns the reference target item.

Method Detail

getCrossReferences

java.util.Collection<ICrossReference> getCrossReferences(com.arcway.cockpit.modulelib2.client.docgen.provider.interfaces.IModuleData referenceTarget)

Returns the cross reference items.

Parameters:

referenceTarget - the reference target

Returns:

the cross reference items

getCrossReferencesWithCategory

java.util.Collection<ICrossReference> getCrossReferencesWithCategory(com.arcway.cockpit.modulelib2.client.docgen.provider.interfaces.IModuleData referenceTarget,
                                                                     java.lang.String categoryID)

Returns the cross reference items that belong to the specified category.

Parameters:

referenceTarget - the reference target

categoryID - the category ID

Returns:

the cross reference items

getCrossReferencesWithDefaultCategory

java.util.Collection<ICrossReference> getCrossReferencesWithDefaultCategory(com.arcway.cockpit.modulelib2.client.docgen.provider.interfaces.IModuleData referenceTarget)

Returns the cross reference items that belong to the default category.

Parameters:

referenceTarget - the reference target

Returns:

the cross reference items

getReferenceTarget

com.arcway.cockpit.modulelib2.client.docgen.provider.interfaces.IModuleData getReferenceTarget(com.arcway.cockpit.genericmodule.docgen.provider.interfaces.IGenericModuleData crossReference)

Returns the reference target item.

Parameters:

crossReference - the cross reference

Returns:

the reference target item or null if none is linked