com.arcway.cockpit.genericmodule.cml_uc_req.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 useCaseRequirementLinkReportProvider.

Method Summary

Modifier and Type	Method and Description
java.util.Collection<com.arcway.cockpit.genericmodule.requirementsmodule3.docgen.provider.interfaces.IRequirement>	getDerivedRequirements(com.arcway.cockpit.usecasemodule.docgen.provider.interfaces.IUseCase underlyingUseCase) Returns the derived requirement items.
java.util.Collection<com.arcway.cockpit.genericmodule.requirementsmodule3.docgen.provider.interfaces.IRequirement>	getDerivedRequirementsWithCategory(com.arcway.cockpit.usecasemodule.docgen.provider.interfaces.IUseCase underlyingUseCase, java.lang.String categoryID) Returns the derived requirement items that belong to the specified category.
java.util.Collection<com.arcway.cockpit.genericmodule.requirementsmodule3.docgen.provider.interfaces.IRequirement>	getDerivedRequirementsWithDefaultCategory(com.arcway.cockpit.usecasemodule.docgen.provider.interfaces.IUseCase underlyingUseCase) Returns the derived requirement items that belong to the default category.
java.util.Collection<com.arcway.cockpit.usecasemodule.docgen.provider.interfaces.IUseCase>	getUnderlyingUseCases(com.arcway.cockpit.genericmodule.docgen.provider.interfaces.IGenericModuleData derivedRequirement) Returns the underlying use case items.
java.util.Collection<com.arcway.cockpit.usecasemodule.docgen.provider.interfaces.IUseCase>	getUnderlyingUseCasesWithCategory(com.arcway.cockpit.genericmodule.docgen.provider.interfaces.IGenericModuleData derivedRequirement, java.lang.String categoryID) Returns the underlying use case items that belong to the specified category.
java.util.Collection<com.arcway.cockpit.usecasemodule.docgen.provider.interfaces.IUseCase>	getUnderlyingUseCasesWithDefaultCategory(com.arcway.cockpit.genericmodule.docgen.provider.interfaces.IGenericModuleData derivedRequirement) Returns the underlying use case items that belong to the default category.

Method Detail

getDerivedRequirements

java.util.Collection<com.arcway.cockpit.genericmodule.requirementsmodule3.docgen.provider.interfaces.IRequirement> getDerivedRequirements(com.arcway.cockpit.usecasemodule.docgen.provider.interfaces.IUseCase underlyingUseCase)

Returns the derived requirement items.

Parameters:

underlyingUseCase - the underlying use case

Returns:

the derived requirement items

getDerivedRequirementsWithCategory

java.util.Collection<com.arcway.cockpit.genericmodule.requirementsmodule3.docgen.provider.interfaces.IRequirement> getDerivedRequirementsWithCategory(com.arcway.cockpit.usecasemodule.docgen.provider.interfaces.IUseCase underlyingUseCase,
                                                                                                                                                      java.lang.String categoryID)

Returns the derived requirement items that belong to the specified category.

Parameters:

underlyingUseCase - the underlying use case

categoryID - the category ID

Returns:

the derived requirement items

getDerivedRequirementsWithDefaultCategory

java.util.Collection<com.arcway.cockpit.genericmodule.requirementsmodule3.docgen.provider.interfaces.IRequirement> getDerivedRequirementsWithDefaultCategory(com.arcway.cockpit.usecasemodule.docgen.provider.interfaces.IUseCase underlyingUseCase)

Returns the derived requirement items that belong to the default category.

Parameters:

underlyingUseCase - the underlying use case

Returns:

the derived requirement items

getUnderlyingUseCases

java.util.Collection<com.arcway.cockpit.usecasemodule.docgen.provider.interfaces.IUseCase> getUnderlyingUseCases(com.arcway.cockpit.genericmodule.docgen.provider.interfaces.IGenericModuleData derivedRequirement)

Returns the underlying use case items.

Parameters:

derivedRequirement - the derived requirement

Returns:

the underlying use case items

getUnderlyingUseCasesWithCategory

java.util.Collection<com.arcway.cockpit.usecasemodule.docgen.provider.interfaces.IUseCase> getUnderlyingUseCasesWithCategory(com.arcway.cockpit.genericmodule.docgen.provider.interfaces.IGenericModuleData derivedRequirement,
                                                                                                                             java.lang.String categoryID)

Returns the underlying use case items that belong to the specified category.

Parameters:

derivedRequirement - the derived requirement

categoryID - the category ID

Returns:

the underlying use case items

getUnderlyingUseCasesWithDefaultCategory

java.util.Collection<com.arcway.cockpit.usecasemodule.docgen.provider.interfaces.IUseCase> getUnderlyingUseCasesWithDefaultCategory(com.arcway.cockpit.genericmodule.docgen.provider.interfaces.IGenericModuleData derivedRequirement)

Returns the underlying use case items that belong to the default category.

Parameters:

derivedRequirement - the derived requirement

Returns:

the underlying use case items