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

Interface IIssueDataProvider

All Superinterfaces:

com.arcway.cockpit.genericmodule.issuemodule2.docgen.provider.interfaces.legacy.IIssueDataProvider_Legacy

public interface IIssueDataProvider
extends com.arcway.cockpit.genericmodule.issuemodule2.docgen.provider.interfaces.legacy.IIssueDataProvider_Legacy

The IIssueDataProvider allows to access Issues of a COCKPIT project for document generation. The IIssueDataProvider can be referenced directly within a document template by its name issueDataProvider.

Method Summary

Modifier and Type	Method and Description
IIssueSet	findIssueSet(java.lang.String path) Searches for the issue set item with the specified path.
java.util.List<? extends IIssueNote>	getAllIssueNotes() Returns all issue note items of the project.
java.util.List<? extends IIssueNote>	getAllIssueNotes(int sortingCriterion) Returns all issue note items of the project.
java.util.List<? extends IIssueNote>	getAllIssueNotes(java.lang.String sortingProperty) Returns all issue note items of the project.
java.util.List<? extends IIssueNote>	getAllIssueNotesForHistoryItem(com.arcway.cockpit.docgen.provider.interfaces.IHistoryEntry historyItem) Returns all issue note items which have been modified the last time with the commit identified by the given history item (each time, a user commits the project, a history item is created).
java.util.List<? extends IIssueNote>	getAllIssueNotesWithCategory(java.lang.String categoryID) Returns all issue note items of the project that belong to the specified category.
java.util.List<? extends IIssueNote>	getAllIssueNotesWithCategory(java.lang.String categoryID, int sortingCriterion) Returns all issue note items of the project that belong to the specified category.
java.util.List<? extends IIssueNote>	getAllIssueNotesWithCategory(java.lang.String categoryID, java.lang.String sortingProperty) Returns all issue note items of the project that belong to the specified category.
java.util.List<? extends IIssueNote>	getAllIssueNotesWithDefaultCategory() Returns all issue note items of the project that belong to the default category.
java.util.List<? extends IIssueNote>	getAllIssueNotesWithDefaultCategory(int sortingCriterion) Returns all issue note items of the project that belong to the default category.
java.util.List<? extends IIssueNote>	getAllIssueNotesWithDefaultCategory(java.lang.String sortingProperty) Returns all issue note items of the project that belong to the default category.
java.util.List<? extends IIssue>	getAllIssues() Returns all issue items of the project.
java.util.List<? extends IIssue>	getAllIssues(int sortingCriterion) Returns all issue items of the project.
java.util.List<? extends IIssue>	getAllIssues(java.lang.String sortingProperty) Returns all issue items of the project.
java.util.List<? extends IIssueSet>	getAllIssueSets() Returns all issue set items of the project.
java.util.List<? extends IIssueSet>	getAllIssueSets(int sortingCriterion) Returns all issue set items of the project.
java.util.List<? extends IIssueSet>	getAllIssueSets(java.lang.String sortingProperty) Returns all issue set items of the project.
java.util.List<? extends IIssueSet>	getAllIssueSetsForHistoryItem(com.arcway.cockpit.docgen.provider.interfaces.IHistoryEntry historyItem) Returns all issue set items which have been modified the last time with the commit identified by the given history item (each time, a user commits the project, a history item is created).
java.util.List<? extends IIssueSet>	getAllIssueSetsWithCategory(java.lang.String categoryID) Returns all issue set items of the project that belong to the specified category.
java.util.List<? extends IIssueSet>	getAllIssueSetsWithCategory(java.lang.String categoryID, int sortingCriterion) Returns all issue set items of the project that belong to the specified category.
java.util.List<? extends IIssueSet>	getAllIssueSetsWithCategory(java.lang.String categoryID, java.lang.String sortingProperty) Returns all issue set items of the project that belong to the specified category.
java.util.List<? extends IIssueSet>	getAllIssueSetsWithDefaultCategory() Returns all issue set items of the project that belong to the default category.
java.util.List<? extends IIssueSet>	getAllIssueSetsWithDefaultCategory(int sortingCriterion) Returns all issue set items of the project that belong to the default category.
java.util.List<? extends IIssueSet>	getAllIssueSetsWithDefaultCategory(java.lang.String sortingProperty) Returns all issue set items of the project that belong to the default category.
java.util.List<? extends IIssue>	getAllIssuesForHistoryItem(com.arcway.cockpit.docgen.provider.interfaces.IHistoryEntry historyItem) Returns all issue items which have been modified the last time with the commit identified by the given history item (each time, a user commits the project, a history item is created).
java.util.List<? extends IIssue>	getAllIssuesForModelElement(java.lang.String modelElementUID) Returns all issue items of the project which are linked to the given model element.
java.util.List<? extends IIssue>	getAllIssuesForModelElement(java.lang.String modelElementUID, int sortingCriterion) Returns all issue items of the project which are linked to the given model element.
java.util.List<? extends IIssue>	getAllIssuesForModelElement(java.lang.String modelElementUID, java.lang.String sortingProperty) Returns all issue items of the project which are linked to the given model element.
java.util.List<? extends IIssue>	getAllIssuesNotLinkedToAnyModelElement() Returns all issue items of the project which are not linked to any model element.
java.util.List<? extends IIssue>	getAllIssuesNotLinkedToAnyModelElement(int sortingCriterion) Returns all issue items of the project which are not linked to any model element.
java.util.List<? extends IIssue>	getAllIssuesNotLinkedToAnyModelElement(java.lang.String sortingProperty) Returns all issue items of the project which are not linked to any model element.
java.util.List<? extends IIssue>	getAllIssuesWithCategory(java.lang.String categoryID) Returns all issue items of the project that belong to the specified category.
java.util.List<? extends IIssue>	getAllIssuesWithCategory(java.lang.String categoryID, int sortingCriterion) Returns all issue items of the project that belong to the specified category.
java.util.List<? extends IIssue>	getAllIssuesWithCategory(java.lang.String categoryID, java.lang.String sortingProperty) Returns all issue items of the project that belong to the specified category.
java.util.List<? extends IIssue>	getAllIssuesWithDefaultCategory() Returns all issue items of the project that belong to the default category.
java.util.List<? extends IIssue>	getAllIssuesWithDefaultCategory(int sortingCriterion) Returns all issue items of the project that belong to the default category.
java.util.List<? extends IIssue>	getAllIssuesWithDefaultCategory(java.lang.String sortingProperty) Returns all issue items of the project that belong to the default category.
java.util.List<? extends IIssue>	getAllRootIssues() Returns all root issue items of the project.
java.util.List<? extends IIssue>	getAllRootIssues(int sortingCriterion) Returns all root issue items of the project.
java.util.List<? extends IIssue>	getAllRootIssues(java.lang.String sortingProperty) Returns all root issue items of the project.
java.util.List<? extends IIssueSet>	getAllRootIssueSets() Returns all root issue set items of the project.
java.util.List<? extends IIssueSet>	getAllRootIssueSets(int sortingCriterion) Returns all root issue set items of the project.
java.util.List<? extends IIssueSet>	getAllRootIssueSets(java.lang.String sortingProperty) Returns all root issue set items of the project.
java.util.List<? extends IIssueSet>	getAllRootIssueSetsWithCategory(java.lang.String categoryID) Returns all root issue set items of the project that belong to the specified category.
java.util.List<? extends IIssueSet>	getAllRootIssueSetsWithCategory(java.lang.String categoryID, int sortingCriterion) Returns all root issue set items of the project that belong to the specified category.
java.util.List<? extends IIssueSet>	getAllRootIssueSetsWithCategory(java.lang.String categoryID, java.lang.String sortingProperty) Returns all root issue set items of the project that belong to the specified category.
java.util.List<? extends IIssueSet>	getAllRootIssueSetsWithDefaultCategory() Returns all root issue set items of the project that belong to the default category.
java.util.List<? extends IIssueSet>	getAllRootIssueSetsWithDefaultCategory(int sortingCriterion) Returns all root issue set items of the project that belong to the default category.
java.util.List<? extends IIssueSet>	getAllRootIssueSetsWithDefaultCategory(java.lang.String sortingProperty) Returns all root issue set items of the project that belong to the default category.
java.util.List<? extends IIssue>	getAllRootIssuesWithCategory(java.lang.String categoryID) Returns all root issue items of the project that belong to the specified category.
java.util.List<? extends IIssue>	getAllRootIssuesWithCategory(java.lang.String categoryID, int sortingCriterion) Returns all root issue items of the project that belong to the specified category.
java.util.List<? extends IIssue>	getAllRootIssuesWithCategory(java.lang.String categoryID, java.lang.String sortingProperty) Returns all root issue items of the project that belong to the specified category.
java.util.List<? extends IIssue>	getAllRootIssuesWithDefaultCategory() Returns all root issue items of the project that belong to the default category.
java.util.List<? extends IIssue>	getAllRootIssuesWithDefaultCategory(int sortingCriterion) Returns all root issue items of the project that belong to the default category.
java.util.List<? extends IIssue>	getAllRootIssuesWithDefaultCategory(java.lang.String sortingProperty) Returns all root issue items of the project that belong to the default category.
java.util.List<java.lang.String>	getKnownValuesForIssuePriority() Returns the known values for the priority of issue items.
java.util.List<java.lang.String>	getKnownValuesForIssueStatus() Returns the known values for the status of issue items.
int	getSORT_ISSUE_BY_DUEDATE() Constant for sorting issue items by due date.
int	getSORT_ISSUE_BY_ID() Constant for sorting issue items by id.
int	getSORT_ISSUE_BY_IDANDTITLE() Constant for sorting issue items by id and title.
int	getSORT_ISSUE_BY_PRIORITY() Constant for sorting issue items by priority.
int	getSORT_ISSUE_BY_RESPONSIBLE() Constant for sorting issue items by responsible.
int	getSORT_ISSUE_BY_STATUS() Constant for sorting issue items by status.
int	getSORT_ISSUE_BY_TITLE() Constant for sorting issue items by title.
int	getSORT_ISSUENOTE_BY_NOTETYPE() Constant for sorting issue note items by note-type.
int	getSORT_ISSUESET_BY_NAME() Constant for sorting issue set items by name.
boolean	hasIssuesForModelElement(java.lang.String modelElementUID) Returns whether there are any issue items linked to the specified model element.

Methods inherited from interface com.arcway.cockpit.genericmodule.issuemodule2.docgen.provider.interfaces.legacy.IIssueDataProvider_Legacy

getAllIssuesOfStatus, getAllIssuesSortBy_StatusAsc_PriorityDesc_DueDateAsc, getAllIssuesSortBy_Title, getIssuesForStakeholder, getIssuesForUniqueElement, getIssuesForUniqueElement, getIssuesForUniqueElement, getIssuesForUniqueElementSortBy_StatusAsc_PriorityDesc_DueDateAsc, getRootIssues, getRootIssues, getRootIssues, getRootIssueSets, getRootIssueSets, getRootIssueSets, getSORT_ISSUESET_BY_DESCRIPTION, getUniqueElementsForIssue, hasIssuesForUniqueElement

Method Detail

getSORT_ISSUESET_BY_NAME

int getSORT_ISSUESET_BY_NAME()

Constant for sorting issue set items by name.

Returns:

constant for sorting issue set items by name

getSORT_ISSUE_BY_ID

int getSORT_ISSUE_BY_ID()

Constant for sorting issue items by id.

Returns:

constant for sorting issue items by id

getSORT_ISSUE_BY_TITLE

int getSORT_ISSUE_BY_TITLE()

Constant for sorting issue items by title.

Returns:

constant for sorting issue items by title

getSORT_ISSUE_BY_STATUS

int getSORT_ISSUE_BY_STATUS()

Constant for sorting issue items by status.

Returns:

constant for sorting issue items by status

getSORT_ISSUE_BY_PRIORITY

int getSORT_ISSUE_BY_PRIORITY()

Constant for sorting issue items by priority.

Returns:

constant for sorting issue items by priority

getSORT_ISSUE_BY_DUEDATE

int getSORT_ISSUE_BY_DUEDATE()

Constant for sorting issue items by due date.

Returns:

constant for sorting issue items by due date

getSORT_ISSUE_BY_RESPONSIBLE

int getSORT_ISSUE_BY_RESPONSIBLE()

Constant for sorting issue items by responsible.

Returns:

constant for sorting issue items by responsible

getSORT_ISSUE_BY_IDANDTITLE

int getSORT_ISSUE_BY_IDANDTITLE()

Constant for sorting issue items by id and title.

Returns:

constant for sorting issue items by id and title

getSORT_ISSUENOTE_BY_NOTETYPE

int getSORT_ISSUENOTE_BY_NOTETYPE()

Constant for sorting issue note items by note-type.

Returns:

constant for sorting issue note items by note-type

getAllIssueSets

java.util.List<? extends IIssueSet> getAllIssueSets()

Returns all issue set items of the project.

The issue set items are sorted by name.

Returns:

list of IIssueSet objects (!= null)

getAllIssueSets

java.util.List<? extends IIssueSet> getAllIssueSets(int sortingCriterion)

Returns all issue set items of the project.

Parameters:

sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)

Returns:

list of IIssueSet objects (!= null)

getAllIssueSets

java.util.List<? extends IIssueSet> getAllIssueSets(java.lang.String sortingProperty)

Returns all issue set items of the project.

Parameters:

sortingProperty - specifies the custom property which shall be used as a criterion for sorting

Returns:

list of IIssueSet objects (!= null)

getAllIssueSetsWithCategory

java.util.List<? extends IIssueSet> getAllIssueSetsWithCategory(java.lang.String categoryID)

Returns all issue set items of the project that belong to the specified category.

The issue set items are sorted by name.

Parameters:

categoryID - the category ID

Returns:

list of IIssueSet objects (!= null)

getAllIssueSetsWithCategory

java.util.List<? extends IIssueSet> getAllIssueSetsWithCategory(java.lang.String categoryID,
                                                                int sortingCriterion)

Returns all issue set items of the project that belong to the specified category.

Parameters:

categoryID - the category ID

sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)

Returns:

list of IIssueSet objects (!= null)

getAllIssueSetsWithCategory

java.util.List<? extends IIssueSet> getAllIssueSetsWithCategory(java.lang.String categoryID,
                                                                java.lang.String sortingProperty)

Returns all issue set items of the project that belong to the specified category.

Parameters:

categoryID - the category ID

sortingProperty - specifies the custom property which shall be used as a criterion for sorting

Returns:

list of IIssueSet objects (!= null)

getAllIssueSetsWithDefaultCategory

java.util.List<? extends IIssueSet> getAllIssueSetsWithDefaultCategory()

Returns all issue set items of the project that belong to the default category.

The issue set items are sorted by name.

Returns:

list of IIssueSet objects (!= null)

getAllIssueSetsWithDefaultCategory

java.util.List<? extends IIssueSet> getAllIssueSetsWithDefaultCategory(int sortingCriterion)

Returns all issue set items of the project that belong to the default category.

Parameters:

sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)

Returns:

list of IIssueSet objects (!= null)

getAllIssueSetsWithDefaultCategory

java.util.List<? extends IIssueSet> getAllIssueSetsWithDefaultCategory(java.lang.String sortingProperty)

Returns all issue set items of the project that belong to the default category.

Parameters:

sortingProperty - specifies the custom property which shall be used as a criterion for sorting

Returns:

list of IIssueSet objects (!= null)

getAllRootIssueSets

java.util.List<? extends IIssueSet> getAllRootIssueSets()

Returns all root issue set items of the project.

The issue set items are returned in their natural order.

Returns:

list of IIssueSet objects (!= null)

getAllRootIssueSets

java.util.List<? extends IIssueSet> getAllRootIssueSets(int sortingCriterion)

Returns all root issue set items of the project.

Parameters:

sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)

Returns:

list of IIssueSet objects (!= null)

getAllRootIssueSets

java.util.List<? extends IIssueSet> getAllRootIssueSets(java.lang.String sortingProperty)

Returns all root issue set items of the project.

Parameters:

sortingProperty - specifies the custom property which shall be used as a criterion for sorting

Returns:

list of IIssueSet objects (!= null)

getAllRootIssueSetsWithCategory

java.util.List<? extends IIssueSet> getAllRootIssueSetsWithCategory(java.lang.String categoryID)

Returns all root issue set items of the project that belong to the specified category.

The issue set items are returned in their natural order.

Parameters:

categoryID - the category ID

Returns:

list of IIssueSet objects (!= null)

getAllRootIssueSetsWithCategory

java.util.List<? extends IIssueSet> getAllRootIssueSetsWithCategory(java.lang.String categoryID,
                                                                    int sortingCriterion)

Returns all root issue set items of the project that belong to the specified category.

Parameters:

categoryID - the category ID

sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)

Returns:

list of IIssueSet objects (!= null)

getAllRootIssueSetsWithCategory

java.util.List<? extends IIssueSet> getAllRootIssueSetsWithCategory(java.lang.String categoryID,
                                                                    java.lang.String sortingProperty)

Returns all root issue set items of the project that belong to the specified category.

Parameters:

categoryID - the category ID

sortingProperty - specifies the custom property which shall be used as a criterion for sorting

Returns:

list of IIssueSet objects (!= null)

getAllRootIssueSetsWithDefaultCategory

java.util.List<? extends IIssueSet> getAllRootIssueSetsWithDefaultCategory()

Returns all root issue set items of the project that belong to the default category.

The issue set items are returned in their natural order.

Returns:

list of IIssueSet objects (!= null)

getAllRootIssueSetsWithDefaultCategory

java.util.List<? extends IIssueSet> getAllRootIssueSetsWithDefaultCategory(int sortingCriterion)

Returns all root issue set items of the project that belong to the default category.

Parameters:

sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)

Returns:

list of IIssueSet objects (!= null)

getAllRootIssueSetsWithDefaultCategory

java.util.List<? extends IIssueSet> getAllRootIssueSetsWithDefaultCategory(java.lang.String sortingProperty)

Returns all root issue set items of the project that belong to the default category.

Parameters:

sortingProperty - specifies the custom property which shall be used as a criterion for sorting

Returns:

list of IIssueSet objects (!= null)

getAllIssueSetsForHistoryItem

java.util.List<? extends IIssueSet> getAllIssueSetsForHistoryItem(com.arcway.cockpit.docgen.provider.interfaces.IHistoryEntry historyItem)

Returns all issue set items which have been modified the last time with the commit identified by the given history item (each time, a user commits the project, a history item is created).

Note: For the purpose of this method, the current version of an issue set is only assigned to the history item for the commit of the last change of the issue set. This method does not allow to access old versions.

Parameters:

historyItem - history item identifying the last change of the issue set items

Returns:

all issue set items modified the last time with the specified commit

getAllIssues

java.util.List<? extends IIssue> getAllIssues()

Returns all issue items of the project.

The issue items are sorted by id and title.

Returns:

list of IIssue objects (!= null)

getAllIssues

java.util.List<? extends IIssue> getAllIssues(int sortingCriterion)

Returns all issue items of the project.

Parameters:

sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)

Returns:

list of IIssue objects (!= null)

getAllIssues

java.util.List<? extends IIssue> getAllIssues(java.lang.String sortingProperty)

Returns all issue items of the project.

Parameters:

sortingProperty - specifies the custom property which shall be used as a criterion for sorting

Returns:

list of IIssue objects (!= null)

getAllIssuesWithCategory

java.util.List<? extends IIssue> getAllIssuesWithCategory(java.lang.String categoryID)

Returns all issue items of the project that belong to the specified category.

The issue items are sorted by id and title.

Parameters:

categoryID - the category ID

Returns:

list of IIssue objects (!= null)

getAllIssuesWithCategory

java.util.List<? extends IIssue> getAllIssuesWithCategory(java.lang.String categoryID,
                                                          int sortingCriterion)

Returns all issue items of the project that belong to the specified category.

Parameters:

categoryID - the category ID

sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)

Returns:

list of IIssue objects (!= null)

getAllIssuesWithCategory

java.util.List<? extends IIssue> getAllIssuesWithCategory(java.lang.String categoryID,
                                                          java.lang.String sortingProperty)

Returns all issue items of the project that belong to the specified category.

Parameters:

categoryID - the category ID

sortingProperty - specifies the custom property which shall be used as a criterion for sorting

Returns:

list of IIssue objects (!= null)

getAllIssuesWithDefaultCategory

java.util.List<? extends IIssue> getAllIssuesWithDefaultCategory()

Returns all issue items of the project that belong to the default category.

The issue items are sorted by id and title.

Returns:

list of IIssue objects (!= null)

getAllIssuesWithDefaultCategory

java.util.List<? extends IIssue> getAllIssuesWithDefaultCategory(int sortingCriterion)

Returns all issue items of the project that belong to the default category.

Parameters:

sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)

Returns:

list of IIssue objects (!= null)

getAllIssuesWithDefaultCategory

java.util.List<? extends IIssue> getAllIssuesWithDefaultCategory(java.lang.String sortingProperty)

Returns all issue items of the project that belong to the default category.

Parameters:

sortingProperty - specifies the custom property which shall be used as a criterion for sorting

Returns:

list of IIssue objects (!= null)

getAllRootIssues

java.util.List<? extends IIssue> getAllRootIssues()

Returns all root issue items of the project.

The issue items are returned in their natural order.

Returns:

list of IIssue objects (!= null)

getAllRootIssues

java.util.List<? extends IIssue> getAllRootIssues(int sortingCriterion)

Returns all root issue items of the project.

Parameters:

sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)

Returns:

list of IIssue objects (!= null)

getAllRootIssues

java.util.List<? extends IIssue> getAllRootIssues(java.lang.String sortingProperty)

Returns all root issue items of the project.

Parameters:

sortingProperty - specifies the custom property which shall be used as a criterion for sorting

Returns:

list of IIssue objects (!= null)

getAllRootIssuesWithCategory

java.util.List<? extends IIssue> getAllRootIssuesWithCategory(java.lang.String categoryID)

Returns all root issue items of the project that belong to the specified category.

The issue items are returned in their natural order.

Parameters:

categoryID - the category ID

Returns:

list of IIssue objects (!= null)

getAllRootIssuesWithCategory

java.util.List<? extends IIssue> getAllRootIssuesWithCategory(java.lang.String categoryID,
                                                              int sortingCriterion)

Returns all root issue items of the project that belong to the specified category.

Parameters:

categoryID - the category ID

sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)

Returns:

list of IIssue objects (!= null)

getAllRootIssuesWithCategory

java.util.List<? extends IIssue> getAllRootIssuesWithCategory(java.lang.String categoryID,
                                                              java.lang.String sortingProperty)

Returns all root issue items of the project that belong to the specified category.

Parameters:

categoryID - the category ID

sortingProperty - specifies the custom property which shall be used as a criterion for sorting

Returns:

list of IIssue objects (!= null)

getAllRootIssuesWithDefaultCategory

java.util.List<? extends IIssue> getAllRootIssuesWithDefaultCategory()

Returns all root issue items of the project that belong to the default category.

The issue items are returned in their natural order.

Returns:

list of IIssue objects (!= null)

getAllRootIssuesWithDefaultCategory

java.util.List<? extends IIssue> getAllRootIssuesWithDefaultCategory(int sortingCriterion)

Returns all root issue items of the project that belong to the default category.

Parameters:

sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)

Returns:

list of IIssue objects (!= null)

getAllRootIssuesWithDefaultCategory

java.util.List<? extends IIssue> getAllRootIssuesWithDefaultCategory(java.lang.String sortingProperty)

Returns all root issue items of the project that belong to the default category.

Parameters:

sortingProperty - specifies the custom property which shall be used as a criterion for sorting

Returns:

list of IIssue objects (!= null)

hasIssuesForModelElement

boolean hasIssuesForModelElement(java.lang.String modelElementUID)

Returns whether there are any issue items linked to the specified model element. The model element is indentified by its unique identifier.

Parameters:

modelElementUID - unique identifier of the model element

Returns:

whether there are any issue items linked to the specified model element

getAllIssuesForModelElement

java.util.List<? extends IIssue> getAllIssuesForModelElement(java.lang.String modelElementUID)

Returns all issue items of the project which are linked to the given model element.

The issue items are sorted by id and title.

Parameters:

modelElementUID - the uid of the model element

Returns:

list of IIssue objects (!= null)

getAllIssuesForModelElement

java.util.List<? extends IIssue> getAllIssuesForModelElement(java.lang.String modelElementUID,
                                                             int sortingCriterion)

Returns all issue items of the project which are linked to the given model element.

Parameters:

modelElementUID - the uid of the model element

sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)

Returns:

list of IIssue objects (!= null)

getAllIssuesForModelElement

java.util.List<? extends IIssue> getAllIssuesForModelElement(java.lang.String modelElementUID,
                                                             java.lang.String sortingProperty)

Returns all issue items of the project which are linked to the given model element.

Parameters:

modelElementUID - the uid of the model element

sortingProperty - specifies the custom property which shall be used as a criterion for sorting

Returns:

list of IIssue objects (!= null)

getAllIssuesNotLinkedToAnyModelElement

java.util.List<? extends IIssue> getAllIssuesNotLinkedToAnyModelElement()

Returns all issue items of the project which are not linked to any model element.

The issue items are sorted by id and title.

Returns:

list of IIssue objects (!= null)

getAllIssuesNotLinkedToAnyModelElement

java.util.List<? extends IIssue> getAllIssuesNotLinkedToAnyModelElement(int sortingCriterion)

Returns all issue items of the project which are not linked to any model element.

Parameters:

sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)

Returns:

list of IIssue objects (!= null)

getAllIssuesNotLinkedToAnyModelElement

java.util.List<? extends IIssue> getAllIssuesNotLinkedToAnyModelElement(java.lang.String sortingProperty)

Returns all issue items of the project which are not linked to any model element.

Parameters:

sortingProperty - specifies the custom property which shall be used as a criterion for sorting

Returns:

list of IIssue objects (!= null)

getAllIssuesForHistoryItem

java.util.List<? extends IIssue> getAllIssuesForHistoryItem(com.arcway.cockpit.docgen.provider.interfaces.IHistoryEntry historyItem)

Returns all issue items which have been modified the last time with the commit identified by the given history item (each time, a user commits the project, a history item is created).

Note: For the purpose of this method, the current version of an issue is only assigned to the history item for the commit of the last change of the issue. This method does not allow to access old versions.

Parameters:

historyItem - history item identifying the last change of the issue items

Returns:

all issue items modified the last time with the specified commit

getAllIssueNotes

java.util.List<? extends IIssueNote> getAllIssueNotes()

Returns all issue note items of the project.

The issue note items are sorted by note-type.

Returns:

list of IIssueNote objects (!= null)

getAllIssueNotes

java.util.List<? extends IIssueNote> getAllIssueNotes(int sortingCriterion)

Returns all issue note items of the project.

Parameters:

sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)

Returns:

list of IIssueNote objects (!= null)

getAllIssueNotes

java.util.List<? extends IIssueNote> getAllIssueNotes(java.lang.String sortingProperty)

Returns all issue note items of the project.

Parameters:

sortingProperty - specifies the custom property which shall be used as a criterion for sorting

Returns:

list of IIssueNote objects (!= null)

getAllIssueNotesWithCategory

java.util.List<? extends IIssueNote> getAllIssueNotesWithCategory(java.lang.String categoryID)

Returns all issue note items of the project that belong to the specified category.

The issue note items are sorted by note-type.

Parameters:

categoryID - the category ID

Returns:

list of IIssueNote objects (!= null)

getAllIssueNotesWithCategory

java.util.List<? extends IIssueNote> getAllIssueNotesWithCategory(java.lang.String categoryID,
                                                                  int sortingCriterion)

Returns all issue note items of the project that belong to the specified category.

Parameters:

categoryID - the category ID

sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)

Returns:

list of IIssueNote objects (!= null)

getAllIssueNotesWithCategory

java.util.List<? extends IIssueNote> getAllIssueNotesWithCategory(java.lang.String categoryID,
                                                                  java.lang.String sortingProperty)

Returns all issue note items of the project that belong to the specified category.

Parameters:

categoryID - the category ID

sortingProperty - specifies the custom property which shall be used as a criterion for sorting

Returns:

list of IIssueNote objects (!= null)

getAllIssueNotesWithDefaultCategory

java.util.List<? extends IIssueNote> getAllIssueNotesWithDefaultCategory()

Returns all issue note items of the project that belong to the default category.

The issue note items are sorted by note-type.

Returns:

list of IIssueNote objects (!= null)

getAllIssueNotesWithDefaultCategory

java.util.List<? extends IIssueNote> getAllIssueNotesWithDefaultCategory(int sortingCriterion)

Returns all issue note items of the project that belong to the default category.

Parameters:

sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)

Returns:

list of IIssueNote objects (!= null)

getAllIssueNotesWithDefaultCategory

java.util.List<? extends IIssueNote> getAllIssueNotesWithDefaultCategory(java.lang.String sortingProperty)

Returns all issue note items of the project that belong to the default category.

Parameters:

sortingProperty - specifies the custom property which shall be used as a criterion for sorting

Returns:

list of IIssueNote objects (!= null)

getAllIssueNotesForHistoryItem

java.util.List<? extends IIssueNote> getAllIssueNotesForHistoryItem(com.arcway.cockpit.docgen.provider.interfaces.IHistoryEntry historyItem)

Returns all issue note items which have been modified the last time with the commit identified by the given history item (each time, a user commits the project, a history item is created).

Note: For the purpose of this method, the current version of an issue note is only assigned to the history item for the commit of the last change of the issue note. This method does not allow to access old versions.

Parameters:

historyItem - history item identifying the last change of the issue note items

Returns:

all issue note items modified the last time with the specified commit

findIssueSet

IIssueSet findIssueSet(java.lang.String path)

Searches for the issue set item with the specified path. A path is a "/" separated list of issue set names (e.g. "foo1/foo1.2" means "foo1.2" as child issue set of "foo1").

If a issue set name contains a slash ("/"), than the slash must be replaced by a double slash ("//"). Attention: Slashes at the beginning of a issue set name are not supported, because "foo1///foo2" would be interpreted as: "foo2" as a child of "foo1/".

Attention: Only issue set items which pass the filter must be contained in the path.

Parameters:

path - the path

Returns:

the issue set specified by the path if found, null otherwise

getKnownValuesForIssueStatus

java.util.List<java.lang.String> getKnownValuesForIssueStatus()

Returns the known values for the status of issue items.

Returns:

the known values as List of String

getKnownValuesForIssuePriority

java.util.List<java.lang.String> getKnownValuesForIssuePriority()

Returns the known values for the priority of issue items.

Returns:

the known values as List of String