org.squashtest.csp.tm.service
Interface TestCaseLibraryNavigationService

All Superinterfaces:

LibraryNavigationService<TestCaseLibrary,TestCaseFolder,TestCaseLibraryNode>, TestCaseLibraryFinderService

All Known Implementing Classes:

TestCaseLibraryNavigationServiceImpl

public interface TestCaseLibraryNavigationService
extends LibraryNavigationService<TestCaseLibrary,TestCaseFolder,TestCaseLibraryNode>, TestCaseLibraryFinderService

Service for navigation in a TestCase library use case.

Author:

Gregory Fouquet

Method Summary

void	addTestCaseToFolder(long folderId, TestCase testCase) Adds a TestCase to a folder.
void	addTestCaseToFolder(long folderId, TestCase testCase, Map<Long,String> customFieldValues) Adds a TestCase to a folder, and its initial custom field values.
void	addTestCaseToLibrary(long libraryId, TestCase testCase) Adds a TestCase to the root of the library.
void	addTestCaseToLibrary(long libraryId, TestCase testCase, Map<Long,String> customFieldValues) Adds a TestCase to the root of the Library, and its initial custom field values.
TestCase	findTestCase(long testCaseId) Deprecated. use TestCaseFinder.findById(long) instead
List<ExportTestCaseData>	findTestCasesToExportFromNodes(List<Long> nodesIds) Will find all test cases of the given ids and contained in folders of the given ids, and return their information as a list of ExportTestCaseData
List<ExportTestCaseData>	findTestCasesToExportFromProject(List<Long> ids) Will find all test cases found in the given projects and return their information as a list of ExportTestCaseData
ImportSummary	importExcelTestCase(InputStream archiveStream, long libraryId, String encoding) Accepts a stream to a .zip file containing regular folders or excel files and nothing else.

Methods inherited from interface org.squashtest.csp.tm.service.LibraryNavigationService

addFolderToFolder, addFolderToLibrary, copyNodesToFolder, copyNodesToLibrary, deleteNodes, findCreatableLibrary, findFolder, findFolderContent, findLibrary, findLibraryOfRootNodeIfExist, findLibraryRootContent, findParentIfExists, modeNodesToFolder, moveNodesToLibrary, renameFolder, simulateDeletion

Methods inherited from interface org.squashtest.csp.tm.service.TestCaseLibraryFinderService

findLinkableTestCaseLibraries, getPathAsString

Method Detail

addTestCaseToLibrary

void addTestCaseToLibrary(long libraryId,
                          TestCase testCase)

Adds a TestCase to the root of the library. The custom fields will be created with their default value.

Parameters:

libraryId -

testCase -

addTestCaseToLibrary

void addTestCaseToLibrary(long libraryId,
                          TestCase testCase,
                          Map<Long,String> customFieldValues)

Adds a TestCase to the root of the Library, and its initial custom field values. The initial custom field values are passed as a Map, that maps the id of the CustomField to the values of the corresponding CustomFieldValue. Read that last sentence again.

Parameters:

libraryId -

testCase -

customFieldValues -

addTestCaseToFolder

void addTestCaseToFolder(long folderId,
                         TestCase testCase)

Adds a TestCase to a folder. The custom fields will be created with their default value.

Parameters:

libraryId -

testCase -

addTestCaseToFolder

void addTestCaseToFolder(long folderId,
                         TestCase testCase,
                         Map<Long,String> customFieldValues)

Adds a TestCase to a folder, and its initial custom field values. The initial custom field values are passed as a Map, that maps the id of the CustomField to the values of the corresponding CustomFieldValue. Read that last sentence again.

Parameters:

libraryId -

testCase -

customFieldValues -

findTestCase

@Deprecated
TestCase findTestCase(long testCaseId)

Deprecated. use TestCaseFinder.findById(long) instead

Parameters:

testCaseId -

Returns:

importExcelTestCase

ImportSummary importExcelTestCase(InputStream archiveStream,
                                  long libraryId,
                                  String encoding)

Accepts a stream to a .zip file containing regular folders or excel files and nothing else. Will convert the test cases from excel to squash.

Parameters:

archiveStream -

libraryId - the identifier of the library we are importing test cases into.

encoding - the encoding

Returns:

a summary of the operations.

findTestCasesToExportFromProject

List<ExportTestCaseData> findTestCasesToExportFromProject(List<Long> ids)

Will find all test cases found in the given projects and return their information as a list of ExportTestCaseData

Parameters:

libraryIds - ids of Project

Returns:

a list of ExportTestCaseData

findTestCasesToExportFromNodes

List<ExportTestCaseData> findTestCasesToExportFromNodes(@NotNull
                                                        List<Long> nodesIds)

Will find all test cases of the given ids and contained in folders of the given ids, and return their information as a list of ExportTestCaseData

Parameters:

nodesIds - ids of TestCaseLibraryNode

Returns:

a list of ExportTestCaseData