com.arcway.cockpit.modulelib2.client.docgen.provider.interfaces

Interface IGeneralModuleReportProvider

public interface IGeneralModuleReportProvider

The IGeneralModuleReportProvider allows to access to general module information, i.e. module related information which is not confined to a single module (e.g. cross module links). The IIssueDataProvider can be referenced directly within a document template by its name generalModuleReportProvider.

Method Summary

Modifier and Type	Method and Description
java.util.Collection<? extends IModuleData>	getLinkableObjects(IModuleData moduleDataItem, java.lang.String crossModuleLinkTypeID) Returns the linkable objects linked to the given module data item via a link of the specified type.
java.util.Collection<? extends IModuleData>	getLinkableObjectsWithCategory(IModuleData moduleDataItem, java.lang.String crossModuleLinkTypeID, java.lang.String categoryID) Returns the linkable objects that are linked to the given module data item via a link of the specified type and that belong to the specified category.
java.util.Collection<? extends IModuleData>	getLinkableObjectsWithDefaultCategory(IModuleData moduleDataItem, java.lang.String crossModuleLinkTypeID) Returns the linkable objects linked to the given module data item via a link of the specified type and that belong to the default category.
java.util.Collection<? extends IModuleData>	getModuleDataItems(IModuleData linkableObject, java.lang.String crossModuleLinkTypeID) Returns the module data items linked to the given linkable object via a link of the specified type.
java.util.Collection<? extends IModuleData>	getModuleDataItemsWithCategory(IModuleData linkableObject, java.lang.String crossModuleLinkTypeID, java.lang.String categoryID) Returns the module data items that are linked to the given linkable object via a link of the specified type and that belong to the specified category.
java.util.Collection<? extends IModuleData>	getModuleDataItemsWithDefaultCategory(IModuleData linkableObject, java.lang.String crossModuleLinkTypeID) Returns the module data items that are linked to the given linkable object via a link of the default type and that belong to the specified category.

Method Detail

getModuleDataItems

java.util.Collection<? extends IModuleData> getModuleDataItems(IModuleData linkableObject,
                                                               java.lang.String crossModuleLinkTypeID)

Returns the module data items linked to the given linkable object via a link of the specified type.

Parameters:

linkableObject - the linkable object

crossModuleLinkTypeID - the id of the link type

Returns:

the linked module data items

getModuleDataItemsWithCategory

java.util.Collection<? extends IModuleData> getModuleDataItemsWithCategory(IModuleData linkableObject,
                                                                           java.lang.String crossModuleLinkTypeID,
                                                                           java.lang.String categoryID)

Returns the module data items that are linked to the given linkable object via a link of the specified type and that belong to the specified category.

Parameters:

linkableObject - the linkable object

crossModuleLinkTypeID - the id of the link type

the - category ID

Returns:

the linked module data items

getModuleDataItemsWithDefaultCategory

java.util.Collection<? extends IModuleData> getModuleDataItemsWithDefaultCategory(IModuleData linkableObject,
                                                                                  java.lang.String crossModuleLinkTypeID)

Returns the module data items that are linked to the given linkable object via a link of the default type and that belong to the specified category.

Parameters:

linkableObject - the linkable object

crossModuleLinkTypeID - the id of the link type

Returns:

the linked module data items

getLinkableObjects

java.util.Collection<? extends IModuleData> getLinkableObjects(IModuleData moduleDataItem,
                                                               java.lang.String crossModuleLinkTypeID)

Returns the linkable objects linked to the given module data item via a link of the specified type.

Parameters:

moduleDataItem - the module data item

crossModuleLinkTypeID - the id of the link type

Returns:

the linked module data items

getLinkableObjectsWithCategory

java.util.Collection<? extends IModuleData> getLinkableObjectsWithCategory(IModuleData moduleDataItem,
                                                                           java.lang.String crossModuleLinkTypeID,
                                                                           java.lang.String categoryID)

Returns the linkable objects that are linked to the given module data item via a link of the specified type and that belong to the specified category.

Parameters:

moduleDataItem - the module data item

crossModuleLinkTypeID - the id of the link type

categoryID - the category ID

Returns:

the linked module data items

getLinkableObjectsWithDefaultCategory

java.util.Collection<? extends IModuleData> getLinkableObjectsWithDefaultCategory(IModuleData moduleDataItem,
                                                                                  java.lang.String crossModuleLinkTypeID)

Returns the linkable objects linked to the given module data item via a link of the specified type and that belong to the default category.

Parameters:

moduleDataItem - the module data item

crossModuleLinkTypeID - the id of the link type

Returns:

the linked module data items