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

Interface ICrossModuleLinkReportDataProvider

public interface ICrossModuleLinkReportDataProvider

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

Method Summary

Modifier and Type	Method and Description
java.util.Collection<IChange>	getChanges(com.arcway.cockpit.modulelib2.client.docgen.provider.interfaces.IModuleData concernedItem) Returns the change items.
java.util.Collection<IChange>	getChangesWithCategory(com.arcway.cockpit.modulelib2.client.docgen.provider.interfaces.IModuleData concernedItem, java.lang.String categoryID) Returns the change items that belong to the specified category.
java.util.Collection<IChange>	getChangesWithDefaultCategory(com.arcway.cockpit.modulelib2.client.docgen.provider.interfaces.IModuleData concernedItem) Returns the change items that belong to the default category.
java.util.Collection<com.arcway.cockpit.modulelib2.client.docgen.provider.interfaces.IModuleData>	getConcernedItems(com.arcway.cockpit.genericmodule.docgen.provider.interfaces.IGenericModuleData change) 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 change, 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 change, 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 change, 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 change) 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 change, java.lang.String itemType) Returns the concerned item items of the specified type that belong to the default category.
java.util.Collection<IPublication>	getPublications(com.arcway.cockpit.modulelib2.client.docgen.provider.interfaces.IModuleData reference) Returns the publication items.
java.util.Collection<IPublication>	getPublicationsWithCategory(com.arcway.cockpit.modulelib2.client.docgen.provider.interfaces.IModuleData reference, java.lang.String categoryID) Returns the publication items that belong to the specified category.
java.util.Collection<IPublication>	getPublicationsWithDefaultCategory(com.arcway.cockpit.modulelib2.client.docgen.provider.interfaces.IModuleData reference) Returns the publication items that belong to the default category.
java.util.Collection<com.arcway.cockpit.modulelib2.client.docgen.provider.interfaces.IModuleData>	getReferences(com.arcway.cockpit.genericmodule.docgen.provider.interfaces.IGenericModuleData publication) Returns the reference items.
java.util.Collection<com.arcway.cockpit.modulelib2.client.docgen.provider.interfaces.IModuleData>	getReferences(com.arcway.cockpit.genericmodule.docgen.provider.interfaces.IGenericModuleData publication, java.lang.String itemType) Returns the reference items of the specified type.
java.util.Collection<com.arcway.cockpit.modulelib2.client.docgen.provider.interfaces.IModuleData>	getReferencesWithCategory(com.arcway.cockpit.genericmodule.docgen.provider.interfaces.IGenericModuleData publication, java.lang.String categoryID) Returns the reference items that belong to the specified category.
java.util.Collection<com.arcway.cockpit.modulelib2.client.docgen.provider.interfaces.IModuleData>	getReferencesWithCategory(com.arcway.cockpit.genericmodule.docgen.provider.interfaces.IGenericModuleData publication, java.lang.String itemType, java.lang.String categoryID) Returns the reference items of the specified type that belong to the specified category.
java.util.Collection<com.arcway.cockpit.modulelib2.client.docgen.provider.interfaces.IModuleData>	getReferencesWithDefaultCategory(com.arcway.cockpit.genericmodule.docgen.provider.interfaces.IGenericModuleData publication) Returns the reference items that belong to the default category.
java.util.Collection<com.arcway.cockpit.modulelib2.client.docgen.provider.interfaces.IModuleData>	getReferencesWithDefaultCategory(com.arcway.cockpit.genericmodule.docgen.provider.interfaces.IGenericModuleData publication, java.lang.String itemType) Returns the reference items of the specified type that belong to the default category.

Method Detail

getChanges

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

Returns the change items.

Parameters:

concernedItem - the concerned item

Returns:

the change items

getChangesWithCategory

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

Returns the change items that belong to the specified category.

Parameters:

concernedItem - the concerned item

categoryID - the category ID

Returns:

the change items

getChangesWithDefaultCategory

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

Returns the change items that belong to the default category.

Parameters:

concernedItem - the concerned item

Returns:

the change items

getConcernedItems

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

Returns the concerned item items.

Parameters:

change - the change

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 change,
                                                                                                                                java.lang.String categoryID)

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

Parameters:

change - the change

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 change)

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

Parameters:

change - the change

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 change,
                                                                                                                    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:

change - the change

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 change,
                                                                                                                                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:

change - the change

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 change,
                                                                                                                                       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:

change - the change

itemType - the item type

Returns:

the concerned item of the specified type

getPublications

java.util.Collection<IPublication> getPublications(com.arcway.cockpit.modulelib2.client.docgen.provider.interfaces.IModuleData reference)

Returns the publication items.

Parameters:

reference - the reference

Returns:

the publication items

getPublicationsWithCategory

java.util.Collection<IPublication> getPublicationsWithCategory(com.arcway.cockpit.modulelib2.client.docgen.provider.interfaces.IModuleData reference,
                                                               java.lang.String categoryID)

Returns the publication items that belong to the specified category.

Parameters:

reference - the reference

categoryID - the category ID

Returns:

the publication items

getPublicationsWithDefaultCategory

java.util.Collection<IPublication> getPublicationsWithDefaultCategory(com.arcway.cockpit.modulelib2.client.docgen.provider.interfaces.IModuleData reference)

Returns the publication items that belong to the default category.

Parameters:

reference - the reference

Returns:

the publication items

getReferences

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

Returns the reference items.

Parameters:

publication - the publication

Returns:

the reference items

getReferencesWithCategory

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

Returns the reference items that belong to the specified category.

Parameters:

publication - the publication

categoryID - the category ID

Returns:

the reference items

getReferencesWithDefaultCategory

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

Returns the reference items that belong to the default category.

Parameters:

publication - the publication

Returns:

the reference items

getReferences

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

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

Parameters:

publication - the publication

itemType - the item type

Returns:

the reference of the specified type

getReferencesWithCategory

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

Returns the reference 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:

publication - the publication

itemType - the item type

categoryID - the category ID

Returns:

the reference of the specified type

getReferencesWithDefaultCategory

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

Returns the reference 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:

publication - the publication

itemType - the item type

Returns:

the reference of the specified type