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

Interface ICrossModuleLinkReportDataProvider

All Superinterfaces:

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

public interface ICrossModuleLinkReportDataProvider
extends com.arcway.cockpit.genericmodule.issuemodule2.docgen.provider.interfaces.legacy.IIssueLinkReportProvider_Legacy

The ICrossModuleLinkReportDataProvider allows to access related items from other modules.
The ICrossModuleLinkReportDataProvider can be referenced directly within a document template by its name issueLinkReportProvider.

Method Summary

Modifier and Type	Method and Description
java.util.Collection<com.arcway.cockpit.modulelib2.client.docgen.provider.interfaces.IModuleData>	getConcernedItems(com.arcway.cockpit.genericmodule.docgen.provider.interfaces.IGenericModuleData issue) Returns the concerned item items.
java.util.Collection<com.arcway.cockpit.modulelib2.client.docgen.provider.interfaces.IModuleData>	getConcernedItems(com.arcway.cockpit.genericmodule.docgen.provider.interfaces.IGenericModuleData issue, java.lang.String itemType) Returns the concerned item items of the specified type.
java.util.Collection<com.arcway.cockpit.modulelib2.client.docgen.provider.interfaces.IModuleData>	getConcernedItemsWithCategory(com.arcway.cockpit.genericmodule.docgen.provider.interfaces.IGenericModuleData issue, java.lang.String categoryID) Returns the concerned item items that belong to the specified category.
java.util.Collection<com.arcway.cockpit.modulelib2.client.docgen.provider.interfaces.IModuleData>	getConcernedItemsWithCategory(com.arcway.cockpit.genericmodule.docgen.provider.interfaces.IGenericModuleData issue, java.lang.String itemType, java.lang.String categoryID) Returns the concerned item items of the specified type that belong to the specified category.
java.util.Collection<com.arcway.cockpit.modulelib2.client.docgen.provider.interfaces.IModuleData>	getConcernedItemsWithDefaultCategory(com.arcway.cockpit.genericmodule.docgen.provider.interfaces.IGenericModuleData issue) Returns the concerned item items that belong to the default category.
java.util.Collection<com.arcway.cockpit.modulelib2.client.docgen.provider.interfaces.IModuleData>	getConcernedItemsWithDefaultCategory(com.arcway.cockpit.genericmodule.docgen.provider.interfaces.IGenericModuleData issue, java.lang.String itemType) Returns the concerned item items of the specified type that belong to the default category.
java.util.Collection<IIssue>	getIssues(com.arcway.cockpit.modulelib2.client.docgen.provider.interfaces.IModuleData concernedItem) Returns the issue items.
java.util.Collection<IIssue>	getIssuesWithCategory(com.arcway.cockpit.modulelib2.client.docgen.provider.interfaces.IModuleData concernedItem, java.lang.String categoryID) Returns the issue items that belong to the specified category.
java.util.Collection<IIssue>	getIssuesWithDefaultCategory(com.arcway.cockpit.modulelib2.client.docgen.provider.interfaces.IModuleData concernedItem) Returns the issue items that belong to the default category.

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

getModuleDataItems, getModuleDataItems, getRelatedIssues

Method Detail

getIssues

java.util.Collection<IIssue> getIssues(com.arcway.cockpit.modulelib2.client.docgen.provider.interfaces.IModuleData concernedItem)

Returns the issue items.

Parameters:

concernedItem - the concerned item

Returns:

the issue items

getIssuesWithCategory

java.util.Collection<IIssue> getIssuesWithCategory(com.arcway.cockpit.modulelib2.client.docgen.provider.interfaces.IModuleData concernedItem,
                                                   java.lang.String categoryID)

Returns the issue items that belong to the specified category.

Parameters:

concernedItem - the concerned item

categoryID - the category ID

Returns:

the issue items

getIssuesWithDefaultCategory

java.util.Collection<IIssue> getIssuesWithDefaultCategory(com.arcway.cockpit.modulelib2.client.docgen.provider.interfaces.IModuleData concernedItem)

Returns the issue items that belong to the default category.

Parameters:

concernedItem - the concerned item

Returns:

the issue items

getConcernedItems

java.util.Collection<com.arcway.cockpit.modulelib2.client.docgen.provider.interfaces.IModuleData> getConcernedItems(com.arcway.cockpit.genericmodule.docgen.provider.interfaces.IGenericModuleData issue)

Returns the concerned item items.

Parameters:

issue - the issue

Returns:

the concerned item items

getConcernedItemsWithCategory

java.util.Collection<com.arcway.cockpit.modulelib2.client.docgen.provider.interfaces.IModuleData> getConcernedItemsWithCategory(com.arcway.cockpit.genericmodule.docgen.provider.interfaces.IGenericModuleData issue,
                                                                                                                                java.lang.String categoryID)

Returns the concerned item items that belong to the specified category.

Parameters:

issue - the issue

categoryID - the category ID

Returns:

the concerned item items

getConcernedItemsWithDefaultCategory

java.util.Collection<com.arcway.cockpit.modulelib2.client.docgen.provider.interfaces.IModuleData> getConcernedItemsWithDefaultCategory(com.arcway.cockpit.genericmodule.docgen.provider.interfaces.IGenericModuleData issue)

Returns the concerned item items that belong to the default category.

Parameters:

issue - the issue

Returns:

the concerned item items

getConcernedItems

java.util.Collection<com.arcway.cockpit.modulelib2.client.docgen.provider.interfaces.IModuleData> getConcernedItems(com.arcway.cockpit.genericmodule.docgen.provider.interfaces.IGenericModuleData issue,
                                                                                                                    java.lang.String itemType)

Returns the concerned item items of the specified type. For the item type constant see the java doc of the interface of the respective type.

Parameters:

issue - the issue

itemType - the item type

Returns:

the concerned item of the specified type

getConcernedItemsWithCategory

java.util.Collection<com.arcway.cockpit.modulelib2.client.docgen.provider.interfaces.IModuleData> getConcernedItemsWithCategory(com.arcway.cockpit.genericmodule.docgen.provider.interfaces.IGenericModuleData issue,
                                                                                                                                java.lang.String itemType,
                                                                                                                                java.lang.String categoryID)

Returns the concerned item items of the specified type that belong to the specified category. For the item type constant see the java doc of the interface of the respective type.

Parameters:

issue - the issue

itemType - the item type

categoryID - the category ID

Returns:

the concerned item of the specified type

getConcernedItemsWithDefaultCategory

java.util.Collection<com.arcway.cockpit.modulelib2.client.docgen.provider.interfaces.IModuleData> getConcernedItemsWithDefaultCategory(com.arcway.cockpit.genericmodule.docgen.provider.interfaces.IGenericModuleData issue,
                                                                                                                                       java.lang.String itemType)

Returns the concerned item items of the specified type that belong to the default category. For the item type constant see the java doc of the interface of the respective type.

Parameters:

issue - the issue

itemType - the item type

Returns:

the concerned item of the specified type