org.squashtest.tm.service.testcase

Interface TestCaseLibraryFinderService

All Known Subinterfaces:

TestCaseLibraryNavigationService

All Known Implementing Classes:

TestCaseLibraryNavigationServiceImpl

public interface TestCaseLibraryFinderService

Author:

Gregory Fouquet

Method Summary

Methods

Modifier and Type	Method and Description
int	countSiblingsOfNode(long nodeId) returns how many nodes belongs to the same collection of the node being referenced by this id (this node is included in the count).
List<org.squashtest.tm.domain.testcase.TestCaseLibrary>	findLinkableTestCaseLibraries() Returns the collection of TestCaseLibrarys which TestCases can be linked by a TestCase via a CallTestStep
org.squashtest.tm.domain.testcase.TestCaseLibraryNode	findNodeByPath(String path) Same than above, but for one path only.
Long	findNodeIdByPath(String path) Same as findNodeIdsByPath(List), for one test case only.
List<Long>	findNodeIdsByPath(List<String> path) Given a list of paths of library NODE, return the ids of those nodes.
List<org.squashtest.tm.domain.testcase.TestCaseLibraryNode>	findNodesByPath(List<String> path) Same than above, but returns the entities instead.
Collection<Long>	findTestCaseIdsFromSelection(Collection<Long> libraryIds, Collection<Long> nodeIds) same as findTestCaseIdsFromSelection(Collection, Collection), with includedCalledTests = false
Collection<Long>	findTestCaseIdsFromSelection(Collection<Long> libraryIds, Collection<Long> nodeIds, boolean includeCalledTests) Passing the ids of some selected TestCaseLibrary and TestCaseLibraryNodes (in separate collections), will return the ids of the TestCases encompassed by this selection.
String	getPathAsString(long entityId) Returns the path of a TestCaseLibraryNode given its id.
List<String>	getPathsAsString(List<Long> ids) Given a list of ids of library NODE, return the path of those nodes.
TestCaseStatisticsBundle	getStatisticsForSelection(Collection<Long> libraryIds, Collection<Long> nodeIds) Passing the ids of some selected TestCaseLibrary and TestCaseLibraryNodes (in separate collections), will return the statistics covering all the TestCases encompassed by this selection.
TestCaseStatisticsBundle	getStatisticsForSelection(Collection<Long> libraryIds, Collection<Long> nodeIds, org.squashtest.tm.domain.milestone.Milestone activeMilestone) Passing the ids of some selected TestCaseLibrary and TestCaseLibraryNodes (in separate collections), will return the statistics covering all the TestCases encompassed by this selection.

Method Detail

findLinkableTestCaseLibraries

List<org.squashtest.tm.domain.testcase.TestCaseLibrary> findLinkableTestCaseLibraries()

Returns the collection of TestCaseLibrarys which TestCases can be linked by a TestCase via a CallTestStep

Returns:

getPathAsString

String getPathAsString(long entityId)

Returns the path of a TestCaseLibraryNode given its id. The format is standard, beginning with /<project-name> Item separator is '/'. If an item name contains a '\', it will be escaped as '\/'.

Parameters:

entityId - the id of the node.

Returns:

the path of that node.

getPathsAsString

List<String> getPathsAsString(List<Long> ids)

Given a list of ids of library NODE, return the path of those nodes. The path starts with /<projectname>. The path is slash-separated '/'. If one of the elements in the path uses a '/', it will be escaped as '\/'.

The order of the result is consistent with the order of the input. If an element could not be found (an invalid id for instance), the corresponding path in the result is NULL.

Parameters:

ids -

Returns:

findNodeIdsByPath

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

Given a list of paths of library NODE, return the ids of those nodes. The path starts with /<projectname>. Like in getPathsAsString(List) a path is slash-separated '/', but this time names containing a '/' don't need escaping (you may use escaped or unescaped names as will).

The order of the result is consistent with the order of the input. If an element could not be found (an invalid path for instance), the corresponding id in the result is NULL.

Parameters:

path -

Returns:

findNodeIdByPath

Long findNodeIdByPath(String path)

Same as findNodeIdsByPath(List), for one test case only.

Parameters:

path -

Returns:

the node id or null

findNodesByPath

List<org.squashtest.tm.domain.testcase.TestCaseLibraryNode> findNodesByPath(List<String> path)

Same than above, but returns the entities instead.

Parameters:

path -

Returns:

findNodeByPath

org.squashtest.tm.domain.testcase.TestCaseLibraryNode findNodeByPath(String path)

Same than above, but for one path only.

Parameters:

path -

Returns:

the matching node or null

getStatisticsForSelection

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

Passing the ids of some selected TestCaseLibrary and TestCaseLibraryNodes (in separate collections), will return the statistics covering all the TestCases encompassed by this selection. The test case ids that cannot be accessed for security reason will be filtered out.

Parameters:

libraryIds -

nodeIds -

Returns:

TestcaseStatisticsBundle

getStatisticsForSelection

TestCaseStatisticsBundle getStatisticsForSelection(Collection<Long> libraryIds,
                                                 Collection<Long> nodeIds,
                                                 org.squashtest.tm.domain.milestone.Milestone activeMilestone)

Passing the ids of some selected TestCaseLibrary and TestCaseLibraryNodes (in separate collections), will return the statistics covering all the TestCases encompassed by this selection. This selection will be filtered by the milestone. The test case ids that cannot be accessed for security reason will be filtered out.

Parameters:

libraryIds -

nodeIds -

activeMilestone -

Returns:

TestcaseStatisticsBundle

findTestCaseIdsFromSelection

Collection<Long> findTestCaseIdsFromSelection(Collection<Long> libraryIds,
                                            Collection<Long> nodeIds,
                                            boolean includeCalledTests)

Passing the ids of some selected TestCaseLibrary and TestCaseLibraryNodes (in separate collections), will return the ids of the TestCases encompassed by this selection. If includeCalledTests is true, every test cases being called directly or indirectly will be included. If The test case ids that cannot be accessed for security reason will be filtered out.

Parameters:

libraryIds -

nodeIds -

includeCalledTests -

Returns:

findTestCaseIdsFromSelection

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

same as findTestCaseIdsFromSelection(Collection, Collection), with includedCalledTests = false

Parameters:

libraryIds -

nodeIds -

Returns:

countSiblingsOfNode

int countSiblingsOfNode(long nodeId)

returns how many nodes belongs to the same collection of the node being referenced by this id (this node is included in the count).

Parameters:

testCaseId -

Returns: