org.squashtest.tm.service.testcase

Interface TestCaseLibraryNavigationService

All Superinterfaces:

LibraryNavigationService<org.squashtest.tm.domain.testcase.TestCaseLibrary,org.squashtest.tm.domain.testcase.TestCaseFolder,org.squashtest.tm.domain.testcase.TestCaseLibraryNode>, TestCaseLibraryFinderService

All Known Implementing Classes:

TestCaseLibraryNavigationServiceImpl

public interface TestCaseLibraryNavigationService
extends LibraryNavigationService<org.squashtest.tm.domain.testcase.TestCaseLibrary,org.squashtest.tm.domain.testcase.TestCaseFolder,org.squashtest.tm.domain.testcase.TestCaseLibraryNode>, TestCaseLibraryFinderService

Service for navigation in a TestCase library use case.

Author:

Gregory Fouquet

Method Summary

Methods

Modifier and Type	Method and Description
void	addTestCaseToFolder(long folderId, org.squashtest.tm.domain.testcase.TestCase testCase, Integer position) Adds a TestCase to a folder.
void	addTestCaseToFolder(long folderId, org.squashtest.tm.domain.testcase.TestCase testCase, Map<Long,org.squashtest.tm.domain.customfield.RawValue> customFieldValues, Integer position, List<Long> milestoneIds) Adds a TestCase to a folder, and its initial custom field values.
void	addTestCaseToLibrary(long libraryId, org.squashtest.tm.domain.testcase.TestCase testCase, Integer position) Adds a TestCase to the root of the library.
void	addTestCaseToLibrary(long libraryId, org.squashtest.tm.domain.testcase.TestCase testCase, Map<Long,org.squashtest.tm.domain.customfield.RawValue> customFieldValues, Integer position, List<Long> milestoneIds) Adds a TestCase to the root of the Library, and its initial custom field values.
List<org.squashtest.tm.domain.testcase.TestCaseLibraryNode>	copyNodesToFolder(long destinationId, Long[] sourceNodesIds) will create a deep copy of the given LibraryNodes, paste them in the destination folder, and return the copies.
List<org.squashtest.tm.domain.testcase.TestCaseLibraryNode>	copyNodesToLibrary(long destinationId, Long[] targetId) same, when the destination is a Library.
OperationReport	deleteNodes(List<Long> targetIds) that method should delete the nodes.
File	exportTestCaseAsExcel(List<Long> libraryIds, List<Long> nodeIds, boolean includeCalledTests, boolean keepRteFormat, org.springframework.context.MessageSource messageSource) Will export a selection of test cases as an Excel 2003 (.xls) spreadsheet.
List<Long>	findAllTestCasesLibraryForMilestone(org.squashtest.tm.domain.milestone.Milestone activeMilestone)
List<Long>	findAllTestCasesLibraryNodeForMilestone(org.squashtest.tm.domain.milestone.Milestone activeMilestone)
List<String>	findNamesInFolderStartingWith(long folderId, String nameStart)
List<String>	findNamesInLibraryStartingWith(long libraryId, String nameStart)
List<org.squashtest.tm.domain.testcase.ExportTestCaseData>	findTestCasesToExport(List<Long> libraryIds, List<Long> nodeIds, boolean includeCalledTests) Will find all test cases in the library and node ids supplied in arguments, and return their information as a list of ExportTestCaseData
List<String>	getParentNodesAsStringList(Long nodeId)
ImportSummary	importZipTestCase(InputStream archiveStream, long libraryId, String encoding) Accepts a stream to a .zip file containing regular folders or excel files and nothing else.
Long	mkdirs(String folderpath) given a well formed path (starting with /project), creates a folder at this position if the user is allowed to.
void	moveNodesToFolder(long destinationId, Long[] targetId)
void	moveNodesToFolder(long destinationId, Long[] targetId, int position)
void	moveNodesToLibrary(long destinationId, Long[] targetId)
void	moveNodesToLibrary(long destinationId, Long[] targetId, int position)
ImportLog	performImportExcelTestCase(File excelFile) Proceed to an import returns a complete log for any invalid informations it contains.
File	searchExportTestCaseAsExcel(List<Long> nodeIds, boolean includeCalledTests, boolean keepRteFormat, org.springframework.context.MessageSource messageSource) Will export a selection of test cases as an Excel 2003 (.xls) spreadsheet.
ImportLog	simulateImportExcelTestCase(File excelFile) Simulates an import and returns a complete log for any invalid informations it contains.

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

addFolderToFolder, addFolderToLibrary, findCreatableLibrary, findFolder, findFolderContent, findLibrary, findLibraryOfRootNodeIfExist, findLibraryRootContent, findParentIfExists, simulateDeletion

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

countSiblingsOfNode, findLinkableTestCaseLibraries, findNodeByPath, findNodeIdByPath, findNodeIdsByPath, findNodesByPath, findTestCaseIdsFromSelection, findTestCaseIdsFromSelection, getPathAsString, getPathsAsString, getStatisticsForSelection

Method Detail

addTestCaseToLibrary

void addTestCaseToLibrary(long libraryId,
                        org.squashtest.tm.domain.testcase.TestCase testCase,
                        Integer position)

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

Parameters:

libraryId -

testCase -

position - if non-null and non-negative, the test case will be inserted at that index.

addTestCaseToLibrary

void addTestCaseToLibrary(long libraryId,
                        org.squashtest.tm.domain.testcase.TestCase testCase,
                        Map<Long,org.squashtest.tm.domain.customfield.RawValue> customFieldValues,
                        Integer position,
                        List<Long> milestoneIds)

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 -

position - if non-null and non-negative, the test case will be inserted at that index.

milestoneIds - the list of the ids of the milestones the test case must be bound to

addTestCaseToFolder

void addTestCaseToFolder(long folderId,
                       org.squashtest.tm.domain.testcase.TestCase testCase,
                       Integer position)

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

Parameters:

libraryId -

testCase -

position - if non-null and non-negative, the test case will be inserted at that index.

addTestCaseToFolder

void addTestCaseToFolder(long folderId,
                       org.squashtest.tm.domain.testcase.TestCase testCase,
                       Map<Long,org.squashtest.tm.domain.customfield.RawValue> customFieldValues,
                       Integer position,
                       List<Long> milestoneIds)

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 - Map<String, String||String[]>

position - if non-null and non-negative, the test case will be inserted at that index.

milestoneIds - the ids of the milestones the test case will be bound to

mkdirs

Long mkdirs(String folderpath)

given a well formed path (starting with /project), creates a folder at this position if the user is allowed to. If a folder already exists in that place, creates nothing and returns its id instead.

Parameters:

folderpath -

Returns:

the id of that folder

importZipTestCase

ImportSummary importZipTestCase(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.

simulateImportExcelTestCase

ImportLog simulateImportExcelTestCase(File excelFile)

Simulates an import and returns a complete log for any invalid informations it contains. It does not proceed to an actual import. Note that the structure of that excel file is totally different that the one contained in the zip archive consumed by importZipTestCase(InputStream, long, String)

Parameters:

excelFile -

Returns:

performImportExcelTestCase

ImportLog performImportExcelTestCase(File excelFile)

Proceed to an import returns a complete log for any invalid informations it contains. Contrary to simulateImportExcelTestCase(File) data are actually processed. Note that the structure of that excel file is totally different that the one contained in the zip archive consumed by importZipTestCase(InputStream, long, String)

Parameters:

excelFile -

Returns:

findTestCasesToExport

List<org.squashtest.tm.domain.testcase.ExportTestCaseData> findTestCasesToExport(List<Long> libraryIds,
                                                                               List<Long> nodeIds,
                                                                               boolean includeCalledTests)

Will find all test cases in the library and node ids supplied in arguments, and return their information as a list of ExportTestCaseData

Parameters:

nodesIds - ids of TestCaseLibraryNode

Returns:

a list of ExportTestCaseData

exportTestCaseAsExcel

File exportTestCaseAsExcel(List<Long> libraryIds,
                         List<Long> nodeIds,
                         boolean includeCalledTests,
                         boolean keepRteFormat,
                         org.springframework.context.MessageSource messageSource)

Will export a selection of test cases as an Excel 2003 (.xls) spreadsheet. The selection consists of :

• zero to several libraries
• zero to several nodes

Last, if the selection have some call steps, the called test case can be included in the export if the parameter includeCalledTests is set to true.

Parameters:

libraryIds -

nodeIds -

includeCalledTests -

Returns:

searchExportTestCaseAsExcel

File searchExportTestCaseAsExcel(List<Long> nodeIds,
                               boolean includeCalledTests,
                               boolean keepRteFormat,
                               org.springframework.context.MessageSource messageSource)

Will export a selection of test cases as an Excel 2003 (.xls) spreadsheet. The selection consists of :

• zero to several nodes

Last, if the selection have some call steps, the called test case can be included in the export if the parameter includeCalledTests is set to true.

Parameters:

nodeIds -

includeCalledTests -

Returns:

getParentNodesAsStringList

List<String> getParentNodesAsStringList(Long nodeId)

findNamesInFolderStartingWith

List<String> findNamesInFolderStartingWith(long folderId,
                                         String nameStart)

findNamesInLibraryStartingWith

List<String> findNamesInLibraryStartingWith(long libraryId,
                                          String nameStart)

findAllTestCasesLibraryForMilestone

List<Long> findAllTestCasesLibraryForMilestone(org.squashtest.tm.domain.milestone.Milestone activeMilestone)

findAllTestCasesLibraryNodeForMilestone

List<Long> findAllTestCasesLibraryNodeForMilestone(org.squashtest.tm.domain.milestone.Milestone activeMilestone)

copyNodesToFolder

List<org.squashtest.tm.domain.testcase.TestCaseLibraryNode> copyNodesToFolder(long destinationId,
                                                                            Long[] sourceNodesIds)

Description copied from interface: LibraryNavigationService

will create a deep copy of the given LibraryNodes, paste them in the destination folder, and return the copies.

Specified by:

copyNodesToFolder in interface LibraryNavigationService<org.squashtest.tm.domain.testcase.TestCaseLibrary,org.squashtest.tm.domain.testcase.TestCaseFolder,org.squashtest.tm.domain.testcase.TestCaseLibraryNode>

Parameters:

destinationId - the id of the folder where you need to copy to.

sourceNodesIds - the list of the librarynodes we want copies of.

Returns:

the list of the copies themselves.

copyNodesToLibrary

List<org.squashtest.tm.domain.testcase.TestCaseLibraryNode> copyNodesToLibrary(long destinationId,
                                                                             Long[] targetId)

Description copied from interface: LibraryNavigationService

same, when the destination is a Library.

Specified by:

copyNodesToLibrary in interface LibraryNavigationService<org.squashtest.tm.domain.testcase.TestCaseLibrary,org.squashtest.tm.domain.testcase.TestCaseFolder,org.squashtest.tm.domain.testcase.TestCaseLibraryNode>

Parameters:

destinationId - the id of the library where you need to copy to.

targetId - the list of the librarynodes we want copies of.

Returns:

the list of the copies themselves.

moveNodesToFolder

void moveNodesToFolder(long destinationId,
                     Long[] targetId)

Specified by:

moveNodesToFolder in interface LibraryNavigationService<org.squashtest.tm.domain.testcase.TestCaseLibrary,org.squashtest.tm.domain.testcase.TestCaseFolder,org.squashtest.tm.domain.testcase.TestCaseLibraryNode>

moveNodesToLibrary

void moveNodesToLibrary(long destinationId,
                      Long[] targetId)

Specified by:

moveNodesToLibrary in interface LibraryNavigationService<org.squashtest.tm.domain.testcase.TestCaseLibrary,org.squashtest.tm.domain.testcase.TestCaseFolder,org.squashtest.tm.domain.testcase.TestCaseLibraryNode>

moveNodesToFolder

void moveNodesToFolder(long destinationId,
                     Long[] targetId,
                     int position)

Specified by:

moveNodesToFolder in interface LibraryNavigationService<org.squashtest.tm.domain.testcase.TestCaseLibrary,org.squashtest.tm.domain.testcase.TestCaseFolder,org.squashtest.tm.domain.testcase.TestCaseLibraryNode>

moveNodesToLibrary

void moveNodesToLibrary(long destinationId,
                      Long[] targetId,
                      int position)

Specified by:

moveNodesToLibrary in interface LibraryNavigationService<org.squashtest.tm.domain.testcase.TestCaseLibrary,org.squashtest.tm.domain.testcase.TestCaseFolder,org.squashtest.tm.domain.testcase.TestCaseLibraryNode>

deleteNodes

OperationReport deleteNodes(List<Long> targetIds)

Description copied from interface: LibraryNavigationService

that method should delete the nodes. It still takes care of non deletable nodes so the implementation should filter out the ids who can't be deleted.

Specified by:

deleteNodes in interface LibraryNavigationService<org.squashtest.tm.domain.testcase.TestCaseLibrary,org.squashtest.tm.domain.testcase.TestCaseFolder,org.squashtest.tm.domain.testcase.TestCaseLibraryNode>

Returns: