com.arcway.cockpit.documentmodule.docgen.provider.interfaces

Interface IDocumentDataProvider

public interface IDocumentDataProvider

The IDocumentDataProvider allows to access objects of a COCKPIT project for document generation. The IDocumentDataProvider can be referenced directly within a document template by its name documentDataProvider.

Method Summary

Modifier and Type	Method and Description
java.util.List<? extends IDocumentContainerSet>	getAllCategories() Deprecated.
java.util.List<? extends IDocumentContainerSet>	getAllCategories(int sortingCriterion) Deprecated.
java.util.List<? extends IDocumentContainerSet>	getAllDocumentContainerSets() Returns all document containers of the project The document containers are sorted by name.
java.util.List<? extends IDocumentContainerSet>	getAllDocumentContainerSets(int sortingCriterion) Returns all categories of the project sortingCriterion specifies the criterion for sorting.
java.util.List<? extends IDocumentContainerSet>	getAllDocumentContainerSetsForHistoryItem(com.arcway.cockpit.docgen.provider.interfaces.IHistoryEntry historyEntry) Returns all document container sets which have been modified the last time with the commit identified by the history item.
java.util.List<? extends IDocumentContainer>	getAllDocumentContainersForHistoryItem(com.arcway.cockpit.docgen.provider.interfaces.IHistoryEntry historyEntry) Returns all document containers which have been modified the last time with the commit identified by the history item.
java.util.List<? extends IResourceLocator>	getAllResourceLocatorsForHistoryItem(com.arcway.cockpit.docgen.provider.interfaces.IHistoryEntry historyEntry) Returns all resource locators which have been modified the last time with the commit identified by the history item.
java.util.List<? extends IDocumentContainer>	getDocumentContainersForUniqueElement(java.lang.String uniqueElementUID) Returns all document containers that are linked to a certain unique element.
java.util.List<? extends IDocumentContainer>	getDocumentContainersForUniqueElement(java.lang.String uniqueElementUID, int sortingCriterion) Returns all document containers that are linked to a certain unique element.
int	getSORT_CATEGORY_BY_NAME()
int	getSORT_DOCUMENTCONTAINER_BY_CATEGORY()
int	getSORT_DOCUMENTCONTAINER_BY_NAME()
int	getSORT_DOCUMENTCONTAINERSET_BY_NAME()
int	getSORT_RESOURCELOCATOR_BY_URL()
boolean	hasDocumentContainersForUniqueElement(java.lang.String uniqueElementUID) Checks whether a unique element has linked document containers.

Method Detail

getSORT_DOCUMENTCONTAINER_BY_NAME

int getSORT_DOCUMENTCONTAINER_BY_NAME()

Returns:

for sorting document containers by name

getSORT_DOCUMENTCONTAINER_BY_CATEGORY

int getSORT_DOCUMENTCONTAINER_BY_CATEGORY()

Returns:

Constant for sorting document containers by category

getSORT_RESOURCELOCATOR_BY_URL

int getSORT_RESOURCELOCATOR_BY_URL()

Returns:

Constant for sorting resource locators by URL

getSORT_CATEGORY_BY_NAME

int getSORT_CATEGORY_BY_NAME()

Returns:

Constant for sorting categories by name

getSORT_DOCUMENTCONTAINERSET_BY_NAME

int getSORT_DOCUMENTCONTAINERSET_BY_NAME()

Returns:

Constant for sorting document container sets by name

getAllDocumentContainerSets

java.util.List<? extends IDocumentContainerSet> getAllDocumentContainerSets()

Returns all document containers of the project

The document containers are sorted by name.

Returns:

array of IDocumentContainerSet objects (!= null)

getAllDocumentContainerSets

java.util.List<? extends IDocumentContainerSet> getAllDocumentContainerSets(int sortingCriterion)

Returns all categories of the project

sortingCriterion specifies the criterion for sorting. Use the integer constants in IUseCaseDataProvider.

Parameters:

sortingCriterion - the sorting criterion

Returns:

array of IDocumentContainer objects (!= null)

getAllCategories

@Deprecated
java.util.List<? extends IDocumentContainerSet> getAllCategories()

Deprecated.

Like getAllDocumentContainerSets(). Only for backward compatibility.

Returns:

array of IDocumentContainerSet objects (!= null)

getAllCategories

@Deprecated
java.util.List<? extends IDocumentContainerSet> getAllCategories(int sortingCriterion)

Deprecated.

Like getAllDocumentContainerSets( sortingCriterion ). Only for backward compatibility.

Parameters:

sortingCriterion - the sorting criterion

Returns:

array of IDocumentContainerSet objects (!= null)

hasDocumentContainersForUniqueElement

boolean hasDocumentContainersForUniqueElement(java.lang.String uniqueElementUID)

Checks whether a unique element has linked document containers. The unique element is indentified by its unique identifier

Parameters:

uniqueElementUID - unique identifier of the unique element

Returns:

true, if linked document containers exist, false otherwise

getDocumentContainersForUniqueElement

java.util.List<? extends IDocumentContainer> getDocumentContainersForUniqueElement(java.lang.String uniqueElementUID)

Returns all document containers that are linked to a certain unique element. The unique element is indentified by its unique identifier

The document containers are sorted by name.

Parameters:

uniqueElementUID - unique identifier of the unique element

Returns:

array of IDocumentContainer objects (!= null)

getDocumentContainersForUniqueElement

java.util.List<? extends IDocumentContainer> getDocumentContainersForUniqueElement(java.lang.String uniqueElementUID,
                                                                                   int sortingCriterion)

Returns all document containers that are linked to a certain unique element. The unique element is indentified by its unique identifier

Parameters:

uniqueElementUID - unique identifier of the unique element

sortingCriterion - specifies the criterion for sorting. Use the integer constants in IUseCaseDataProvider.

Returns:

array of IDocumentContainer objects (!= null)

getAllDocumentContainerSetsForHistoryItem

java.util.List<? extends IDocumentContainerSet> getAllDocumentContainerSetsForHistoryItem(com.arcway.cockpit.docgen.provider.interfaces.IHistoryEntry historyEntry)

Returns all document container sets 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 a document container set is only assigned to the history item for the commit of the last change of the document container set. This method does not allow to access old versions.

Preconditions:none
Postconditions:none

Parameters:

historyEntry - history item identifying the last change of the plans

Returns:

all document container sets modified the last time with the given history item

getAllDocumentContainersForHistoryItem

java.util.List<? extends IDocumentContainer> getAllDocumentContainersForHistoryItem(com.arcway.cockpit.docgen.provider.interfaces.IHistoryEntry historyEntry)

Returns all document containers 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 a document container is only assigned to the history item for the commit of the last change of the document container. This method does not allow to access old versions.

Preconditions:none
Postconditions:none

Parameters:

historyEntry - history item identifying the last change of the plans

Returns:

all document containers modified the last time with the given history item

getAllResourceLocatorsForHistoryItem

java.util.List<? extends IResourceLocator> getAllResourceLocatorsForHistoryItem(com.arcway.cockpit.docgen.provider.interfaces.IHistoryEntry historyEntry)

Returns all resource locators 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 a resource locator is only assigned to the history item for the commit of the last change of the resource locator. This method does not allow to access old versions.

Preconditions:none
Postconditions:none

Parameters:

historyEntry - history item identifying the last change of the plans

Returns:

all resource locators modified the last time with the given history item