org.squashtest.tm.service.requirement

Interface RequirementLibraryFinderService

All Known Subinterfaces:

RequirementLibraryNavigationService

All Known Implementing Classes:

RequirementLibraryNavigationServiceImpl

public interface RequirementLibraryFinderService

Author:

Gregory Fouquet

Method Summary

Methods

Modifier and Type	Method and Description
List<org.squashtest.tm.domain.requirement.RequirementLibrary>	findLinkableRequirementLibraries() Returns the collection of RequirementLibrary which Requirements can be linked by a TestCase
Long	findNodeIdByPath(String path) Return the id of the RequirementLibraryNode identified by the path given in argument
Long	findNodeIdByRemoteKey(String remoteKey, String projectName) Return the id of a (synchronized) Requirement, identified by its remote key.
List<Long>	findNodeIdsByPath(List<String> paths) Returns the id list, representing each node on the path.
List<Long>	findNodeIdsByRemoteKeys(List<String> remoteKeys, String projectName) Return a list of synchronized Requirement, given their remote key.
Collection<Long>	findRequirementIdsFromSelection(Collection<Long> libraryIds, Collection<Long> nodeIds) Passing the ids of some selected RequirementLibrary and RequirementLibraryNodes (in separate collections), will return the ids of the Requirements encompassed by this selection.
String	getPathAsString(long entityId) Returns the path of a RequirementLibraryNode given its id.
RequirementStatisticsBundle	getStatisticsForSelection(Collection<Long> libraryIds, Collection<Long> nodeIds) Passing the ids of some selected RequirementLibrary and RequirementLibraryNodes (in separate collections), will return the statistics covering all the Requirements encompassed by this selection.

Method Detail

findLinkableRequirementLibraries

List<org.squashtest.tm.domain.requirement.RequirementLibrary> findLinkableRequirementLibraries()

Returns the collection of RequirementLibrary which Requirements can be linked by a TestCase

Returns:

getPathAsString

String getPathAsString(long entityId)

Returns the path of a RequirementLibraryNode given its id. The format is standard, beginning with /<project-name>

Parameters:

entityId - the id of the node.

Returns:

the path of that node.

findNodeIdsByPath

List<Long> findNodeIdsByPath(List<String> paths)

Returns the id list, representing each node on the path.

Parameters:

paths - A list of paths. This list can be generated by PathUtils.scanPath(String). This method assume that the path contains the project path, but it will NOT return the project Id as member of returned list

Returns:

findNodeIdByPath

Long findNodeIdByPath(String path)

Return the id of the RequirementLibraryNode identified by the path given in argument

Parameters:

path -

Returns:

the id or null if no RequirementLibraryNode have the path

findNodeIdByRemoteKey

Long findNodeIdByRemoteKey(String remoteKey,
                         String projectName)

Return the id of a (synchronized) Requirement, identified by its remote key.

Parameters:

remoyeKey -

Returns:

the id or null if no Requirement have such remote key

findNodeIdsByRemoteKeys

List<Long> findNodeIdsByRemoteKeys(List<String> remoteKeys,
                                 String projectName)

Return a list of synchronized Requirement, given their remote key. The ids will be returned in the same order than the input list. The resulting list might contain null entries if no synchronized Requirement was found for some remote keys.

Parameters:

remoteKeys -

Returns:

findRequirementIdsFromSelection

Collection<Long> findRequirementIdsFromSelection(Collection<Long> libraryIds,
                                               Collection<Long> nodeIds)

Passing the ids of some selected RequirementLibrary and RequirementLibraryNodes (in separate collections), will return the ids of the Requirements encompassed by this selection. the requirement ids that cannot be accessed for security reason will be filtered out.

Parameters:

libraryIds -

nodeIds -

Returns:

getStatisticsForSelection

RequirementStatisticsBundle getStatisticsForSelection(Collection<Long> libraryIds,
                                                    Collection<Long> nodeIds)

Passing the ids of some selected RequirementLibrary and RequirementLibraryNodes (in separate collections), will return the statistics covering all the Requirements encompassed by this selection. The requirement ids that cannot be accessed for security reason will be filtered out.

Parameters:

libraryIds -

nodeIds -

Returns:

RequirementStatisticsBundle