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

Interface IGenericModuleReportDataProvider

public interface IGenericModuleReportDataProvider

The IGenericModuleReportDataProvider allows for access to objects of a generic module for document generation. The IGenericModuleDataProvider for a specific module can be referenced directly within a document template by its name [moduleID]DataProvider (without the square brackets and moduleID replaced by the module's id as specified in the generic module specification).

Method Summary

Modifier and Type	Method and Description
boolean	areAnyItemsLinkedToModelElement(java.lang.String modelElementUID) Returns whether any items are linked to the specified model element.
boolean	areItemsLinkedToModelElement(java.lang.String modelElementUID, java.lang.String objectTypeID) Returns whether any items of the specified type are linked to the specified model element.
IGenericModuleData	findObject(java.lang.String path, java.lang.String objectTypeID) Searches for the item with the specified path.
java.util.List<? extends IGenericModuleData>	getAllObjects(java.lang.String objectTypeID) Returns all objects of the specified type.
java.util.List<? extends IGenericModuleData>	getAllObjects(java.lang.String objectTypeID, java.lang.String attributeToSortBy) Returns all objects of the specified type sorted by the specified attribute.
java.util.List<? extends IGenericModuleData>	getAllObjectsForHistoryItem(java.lang.String objectTypeID, com.arcway.cockpit.docgen.provider.interfaces.IHistoryEntry historyEntry) Returns all objects of the specified type which have been modified the last time with the commit identified by the history item.
java.util.List<? extends IGenericModuleData>	getAllObjectsWithCategory(java.lang.String objectTypeID, java.lang.String categoryID) Returns all objects of the specified type that belong to the specified category.
java.util.List<? extends IGenericModuleData>	getAllObjectsWithCategory(java.lang.String objectTypeID, java.lang.String categoryID, java.lang.String attributeToSortBy) Returns all objects of the specified type that belong to the specified category sorted by the specified attribute.
java.util.List<? extends IGenericModuleData>	getAllObjectsWithDefaultCategory(java.lang.String objectTypeID) Returns all objects of the specified type that belong to the default category.
java.util.List<? extends IGenericModuleData>	getAllObjectsWithDefaultCategory(java.lang.String objectTypeID, java.lang.String attributeToSortBy) Returns all objects of the specified type that belong to the default category sorted by the specified attribute.
java.util.List<? extends IGenericModuleData>	getAllRootObjects(java.lang.String objectTypeID) Returns all root objects of the specified type The objects are by default returned in natural order.
java.util.List<? extends IGenericModuleData>	getAllRootObjects(java.lang.String objectTypeID, java.lang.String attributeToSortBy) Returns all root objects of the specified type sorted by the specified attribute.
java.util.List<? extends IGenericModuleData>	getAllRootObjectsWithCategory(java.lang.String objectTypeID, java.lang.String categoryID) Returns all root objects of the specified type that belong to the specified category.
java.util.List<? extends IGenericModuleData>	getAllRootObjectsWithCategory(java.lang.String objectTypeID, java.lang.String categoryID, java.lang.String attributeToSortBy) Returns all root objects of the specified type that belong to the specified category sorted by the specified attribute.
java.util.List<? extends IGenericModuleData>	getAllRootObjectsWithDefaultCategory(java.lang.String objectTypeID) Returns all root objects of the specified type that belong to the default category.
java.util.List<? extends IGenericModuleData>	getAllRootObjectsWithDefaultCategory(java.lang.String objectTypeID, java.lang.String attributeToSortBy) Returns all root objects of the specified type that belong to the default category sorted by the specified attribute.
java.util.List<? extends IGenericModuleData>	getItemsForModelElement(java.lang.String modelElementUID, java.lang.String objectTypeID) Returns all objects of the specified type that are linked to the specified model element.
java.util.List<? extends IGenericModuleData>	getItemsForModelElement(java.lang.String modelElementUID, java.lang.String objectTypeID, java.lang.String attributeToSortBy) Returns all objects of the specified type that are linked to the specified model element sorted by the specified attribute.
java.util.List<? extends IGenericModuleData>	getItemsNotLinkedToAnyModelElement(java.lang.String objectTypeID) Returns all objects of the specified type that are not linked to any model element.
java.util.List<? extends IGenericModuleData>	getItemsNotLinkedToAnyModelElement(java.lang.String objectTypeID, java.lang.String attributeToSortBy) Returns all objects of the specified type that are not linked to any model element sorted by the specified attribute.
java.util.List<java.lang.String>	getKnownValuesForAttribute(java.lang.String objectTypeID, java.lang.String attributeID) Returns the known values for the specified attribute.

Method Detail

getAllObjects

java.util.List<? extends IGenericModuleData> getAllObjects(java.lang.String objectTypeID)

Returns all objects of the specified type.

The objects are by default sorted by the first specified attribute of the object type.

Parameters:

objectTypeID - the object type id

Returns:

all objects of the given type

getAllObjectsWithCategory

java.util.List<? extends IGenericModuleData> getAllObjectsWithCategory(java.lang.String objectTypeID,
                                                                       java.lang.String categoryID)

Returns all objects of the specified type that belong to the specified category.

The objects are by default sorted by the first specified attribute of the object type.

Parameters:

objectTypeID - the object type id

categoryID - the category ID

Returns:

all objects of the given type

getAllObjectsWithDefaultCategory

java.util.List<? extends IGenericModuleData> getAllObjectsWithDefaultCategory(java.lang.String objectTypeID)

Returns all objects of the specified type that belong to the default category.

The objects are by default sorted by the first specified attribute of the object type.

Parameters:

objectTypeID - the object type id

Returns:

all objects of the given type

getAllObjects

java.util.List<? extends IGenericModuleData> getAllObjects(java.lang.String objectTypeID,
                                                           java.lang.String attributeToSortBy)

Returns all objects of the specified type sorted by the specified attribute.

Parameters:

objectTypeID - the object type id

attributeToSortBy - attribute to sort by

Returns:

all objects of the given type

getAllObjectsWithCategory

java.util.List<? extends IGenericModuleData> getAllObjectsWithCategory(java.lang.String objectTypeID,
                                                                       java.lang.String categoryID,
                                                                       java.lang.String attributeToSortBy)

Returns all objects of the specified type that belong to the specified category sorted by the specified attribute.

Parameters:

objectTypeID - the object type id

categoryID - the category ID

attributeToSortBy - attribute to sort by

Returns:

all objects of the given type

getAllObjectsWithDefaultCategory

java.util.List<? extends IGenericModuleData> getAllObjectsWithDefaultCategory(java.lang.String objectTypeID,
                                                                              java.lang.String attributeToSortBy)

Returns all objects of the specified type that belong to the default category sorted by the specified attribute.

Parameters:

objectTypeID - the object type id

attributeToSortBy - attribute to sort by

Returns:

all objects of the given type

getAllObjectsForHistoryItem

java.util.List<? extends IGenericModuleData> getAllObjectsForHistoryItem(java.lang.String objectTypeID,
                                                                         com.arcway.cockpit.docgen.provider.interfaces.IHistoryEntry historyEntry)

Returns all objects of the specified type which have been modified the last time with the commit identified by the history item.

Each time, a user commits the project, a history entry is created.

Note: The current version of an object is only assigned to the history item for the commit of the last change of the object. This method does not allow to access old versions.

Preconditions:none
Postconditions:none

Parameters:

objectTypeID - the object type id

historyEntry - history item identifying the last change of the plans

Returns:

all object modified the last time with the given history item

getAllRootObjects

java.util.List<? extends IGenericModuleData> getAllRootObjects(java.lang.String objectTypeID)

Returns all root objects of the specified type

The objects are by default returned in natural order.

Parameters:

objectTypeID - the object type id

Returns:

all objects of the given type

getAllRootObjectsWithCategory

java.util.List<? extends IGenericModuleData> getAllRootObjectsWithCategory(java.lang.String objectTypeID,
                                                                           java.lang.String categoryID)

Returns all root objects of the specified type that belong to the specified category.

The objects are by default returned in natural order.

Parameters:

objectTypeID - the object type id

categoryID - the category ID

Returns:

all objects of the given type

getAllRootObjectsWithDefaultCategory

java.util.List<? extends IGenericModuleData> getAllRootObjectsWithDefaultCategory(java.lang.String objectTypeID)

Returns all root objects of the specified type that belong to the default category.

The objects are by default returned in natural order.

Parameters:

objectTypeID - the object type id

Returns:

all objects of the given type

getAllRootObjects

java.util.List<? extends IGenericModuleData> getAllRootObjects(java.lang.String objectTypeID,
                                                               java.lang.String attributeToSortBy)

Returns all root objects of the specified type sorted by the specified attribute.

Parameters:

objectTypeID - the object type id

attributeToSortBy - attribute to sort by

Returns:

all objects of the given type

getAllRootObjectsWithCategory

java.util.List<? extends IGenericModuleData> getAllRootObjectsWithCategory(java.lang.String objectTypeID,
                                                                           java.lang.String categoryID,
                                                                           java.lang.String attributeToSortBy)

Returns all root objects of the specified type that belong to the specified category sorted by the specified attribute.

Parameters:

objectTypeID - the object type id

categoryID - the category ID

attributeToSortBy - attribute to sort by

Returns:

all objects of the given type

getAllRootObjectsWithDefaultCategory

java.util.List<? extends IGenericModuleData> getAllRootObjectsWithDefaultCategory(java.lang.String objectTypeID,
                                                                                  java.lang.String attributeToSortBy)

Returns all root objects of the specified type that belong to the default category sorted by the specified attribute.

Parameters:

objectTypeID - the object type id

attributeToSortBy - attribute to sort by

Returns:

all objects of the given type

findObject

IGenericModuleData findObject(java.lang.String path,
                              java.lang.String objectTypeID)

Searches for the item with the specified path. A path is a "/" separated list of item names (e.g. "foo1/foo1.2" means "foo1.2" as child of "foo1". If an item name contains a slash ("/"), than the slash must be replaced by a double slash ("//"). Attention: Slashes at the beginning of an item name are not supported, because "foo1///foo2" would be interpreted as: "foo2" as a child of "foo1/". Attention: Only items which pass the filter must be contained in the path. Precondition: The item can only be found, if all items in the path are of the same object type, which is specified by the object type id parameter.

Parameters:

path - the path

objectTypeID - the object type id of the item to be found

Returns:

the speciifed item if found, null otherwise

getItemsNotLinkedToAnyModelElement

java.util.List<? extends IGenericModuleData> getItemsNotLinkedToAnyModelElement(java.lang.String objectTypeID)

Returns all objects of the specified type that are not linked to any model element.

The objects are by default sorted by the first specified attribute of the object type.

Parameters:

objectTypeID - the object type id

Returns:

all objects of the given type

getItemsNotLinkedToAnyModelElement

java.util.List<? extends IGenericModuleData> getItemsNotLinkedToAnyModelElement(java.lang.String objectTypeID,
                                                                                java.lang.String attributeToSortBy)

Returns all objects of the specified type that are not linked to any model element sorted by the specified attribute.

Parameters:

objectTypeID - the object type id

attributeToSortBy - attribute to sort by

Returns:

all objects of the given type

areAnyItemsLinkedToModelElement

boolean areAnyItemsLinkedToModelElement(java.lang.String modelElementUID)

Returns whether any items are linked to the specified model element.

Parameters:

modelElementUID - the model element's uid

Returns:

whether any items are linked to the specified model element

areItemsLinkedToModelElement

boolean areItemsLinkedToModelElement(java.lang.String modelElementUID,
                                     java.lang.String objectTypeID)

Returns whether any items of the specified type are linked to the specified model element.

Parameters:

modelElementUID - the model element's uid

objectTypeID - the object type id

Returns:

whether any items are linked to the specified model element

getItemsForModelElement

java.util.List<? extends IGenericModuleData> getItemsForModelElement(java.lang.String modelElementUID,
                                                                     java.lang.String objectTypeID)

Returns all objects of the specified type that are linked to the specified model element.

The objects are by default sorted by the first specified attribute of the object type.

Parameters:

modelElementUID - the model element's uid

objectTypeID - the object type id

Returns:

all objects of the given type

getItemsForModelElement

java.util.List<? extends IGenericModuleData> getItemsForModelElement(java.lang.String modelElementUID,
                                                                     java.lang.String objectTypeID,
                                                                     java.lang.String attributeToSortBy)

Returns all objects of the specified type that are linked to the specified model element sorted by the specified attribute.

Parameters:

modelElementUID - the model element's uid

objectTypeID - the object type id

attributeToSortBy - attribute to sort by

Returns:

all objects of the given type

getKnownValuesForAttribute

java.util.List<java.lang.String> getKnownValuesForAttribute(java.lang.String objectTypeID,
                                                            java.lang.String attributeID)

Returns the known values for the specified attribute.

Works only for linked module data attributes and enumeration attributes (not for numbers, texts, dates, etc).

Parameters:

objectTypeID - the id of the object type the attribute belongs to

attributeID - the attribute's id

Returns:

the known values as List of String