org.squashtest.tm.service.campaign

Interface CampaignLibraryNavigationService

All Superinterfaces:

CampaignLibraryFinderService, LibraryNavigationService<org.squashtest.tm.domain.campaign.CampaignLibrary,org.squashtest.tm.domain.campaign.CampaignFolder,org.squashtest.tm.domain.campaign.CampaignLibraryNode>

All Known Implementing Classes:

CampaignLibraryNavigationServiceImpl

public interface CampaignLibraryNavigationService
extends LibraryNavigationService<org.squashtest.tm.domain.campaign.CampaignLibrary,org.squashtest.tm.domain.campaign.CampaignFolder,org.squashtest.tm.domain.campaign.CampaignLibraryNode>, CampaignLibraryFinderService

Method Summary

Methods

Modifier and Type	Method and Description
void	addCampaignToCampaignFolder(long folderId, org.squashtest.tm.domain.campaign.Campaign campaign) Adds a campaign to a folder.
void	addCampaignToCampaignFolder(long folderId, org.squashtest.tm.domain.campaign.Campaign campaign, Map<Long,org.squashtest.tm.domain.customfield.RawValue> customFieldValues) Adds a campaign to a folder, and its initial custom field values.
void	addCampaignToCampaignLibrary(long libraryId, org.squashtest.tm.domain.campaign.Campaign campaign) Adds a Campaign to the root of the library.
void	addCampaignToCampaignLibrary(long libraryId, org.squashtest.tm.domain.campaign.Campaign campaign, Map<Long,org.squashtest.tm.domain.customfield.RawValue> customFieldValues) Adds a Campaign to the root of the Library, and its initial custom field values.
int	addIterationToCampaign(org.squashtest.tm.domain.campaign.Iteration iteration, long campaignId, boolean copyTestPlan) Adds a new iteration to a campaign.
int	addIterationToCampaign(org.squashtest.tm.domain.campaign.Iteration iteration, long campaignId, boolean copyTestPlan, Map<Long,org.squashtest.tm.domain.customfield.RawValue> customFieldValues) Adds a new iteration to a campaign.
List<org.squashtest.tm.domain.campaign.Iteration>	copyIterationsToCampaign(long campaignId, Long[] iterationsIds)
List<org.squashtest.tm.domain.campaign.CampaignLibraryNode>	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.campaign.CampaignLibraryNode>	copyNodesToLibrary(long destinationId, Long[] targetId) same, when the destination is a Library.
OperationReport	deleteIterations(List<Long> targetIds) that method should delete the iterations.
OperationReport	deleteNodes(List<Long> targetIds) that method should delete the nodes.
OperationReport	deleteSuites(List<Long> suiteIds, boolean removeFromIter) that method should delete test suites, and remove its references in iteration and iteration test plan item
org.squashtest.tm.domain.campaign.export.CampaignExportCSVModel	exportCampaignToCSV(Long campaignId, String exportType) given a campaign Id, returns a model.
List<Long>	findAllCampaignIdsForMilestone(org.squashtest.tm.domain.milestone.Milestone milestone)
List<org.squashtest.tm.domain.campaign.TestSuite>	findIterationContent(long iterationId)
List<org.squashtest.tm.domain.campaign.Iteration>	findIterationsByCampaignId(long campaignId)
List<org.squashtest.tm.domain.campaign.CampaignLibrary>	findLinkableCampaignLibraries() Returns the collection of CampaignLibrarys which Campaigns can be linked by a Campaign via a CallTestStep
List<String>	getParentNodesAsStringList(Long elementId)
void	moveIterationsWithinCampaign(long destinationId, Long[] nodeIds, int position)
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)
List<SuppressionPreviewReport>	simulateIterationDeletion(List<Long> targetIds) that method should investigate the consequences of the deletion request of iterations, and return a report about what will happen.
List<SuppressionPreviewReport>	simulateSuiteDeletion(List<Long> targetIds) that method should investigate the consequences of the deletion request of tes suites, and return a report about what will happen.

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.campaign.CampaignLibraryFinderService

findCampaignIdsFromSelection, gatherCampaignStatisticsBundleByMilestone, getPathAsString

Method Detail

addCampaignToCampaignLibrary

void addCampaignToCampaignLibrary(long libraryId,
                                org.squashtest.tm.domain.campaign.Campaign campaign)

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

Parameters:

libraryId -

campaign -

addCampaignToCampaignLibrary

void addCampaignToCampaignLibrary(long libraryId,
                                org.squashtest.tm.domain.campaign.Campaign campaign,
                                Map<Long,org.squashtest.tm.domain.customfield.RawValue> customFieldValues)

Adds a Campaign 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 -

campaign -

customFieldValues -

addCampaignToCampaignFolder

void addCampaignToCampaignFolder(long folderId,
                               org.squashtest.tm.domain.campaign.Campaign campaign)

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

Parameters:

libraryId -

campaign -

addCampaignToCampaignFolder

void addCampaignToCampaignFolder(long folderId,
                               org.squashtest.tm.domain.campaign.Campaign campaign,
                               Map<Long,org.squashtest.tm.domain.customfield.RawValue> customFieldValues)

Adds a campaign 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 -

campaign -

customFieldValues -

moveIterationsWithinCampaign

void moveIterationsWithinCampaign(long destinationId,
                                Long[] nodeIds,
                                int position)

addIterationToCampaign

int addIterationToCampaign(org.squashtest.tm.domain.campaign.Iteration iteration,
                         long campaignId,
                         boolean copyTestPlan)

Adds a new iteration to a campaign. Returns the index of the new iteration.

Parameters:

iteration -

campaignId -

Returns:

addIterationToCampaign

int addIterationToCampaign(org.squashtest.tm.domain.campaign.Iteration iteration,
                         long campaignId,
                         boolean copyTestPlan,
                         Map<Long,org.squashtest.tm.domain.customfield.RawValue> customFieldValues)

Adds a new iteration to a campaign. Returns the index of the new iteration. 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:

iteration -

campaignId -

customFieldValues -

Returns:

findIterationsByCampaignId

List<org.squashtest.tm.domain.campaign.Iteration> findIterationsByCampaignId(long campaignId)

copyIterationsToCampaign

List<org.squashtest.tm.domain.campaign.Iteration> copyIterationsToCampaign(long campaignId,
                                                                         Long[] iterationsIds)

findIterationContent

List<org.squashtest.tm.domain.campaign.TestSuite> findIterationContent(long iterationId)

findLinkableCampaignLibraries

List<org.squashtest.tm.domain.campaign.CampaignLibrary> findLinkableCampaignLibraries()

Description copied from interface: CampaignLibraryFinderService

Returns the collection of CampaignLibrarys which Campaigns can be linked by a Campaign via a CallTestStep

Specified by:

findLinkableCampaignLibraries in interface CampaignLibraryFinderService

Parameters:

-

Returns:

simulateIterationDeletion

List<SuppressionPreviewReport> simulateIterationDeletion(List<Long> targetIds)

that method should investigate the consequences of the deletion request of iterations, and return a report about what will happen.

Parameters:

targetIds -

Returns:

deleteIterations

OperationReport deleteIterations(List<Long> targetIds)

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

Parameters:

targetIds -

Returns:

simulateSuiteDeletion

List<SuppressionPreviewReport> simulateSuiteDeletion(List<Long> targetIds)

that method should investigate the consequences of the deletion request of tes suites, and return a report about what will happen.

Parameters:

targetIds -

Returns:

deleteSuites

OperationReport deleteSuites(List<Long> suiteIds,
                           boolean removeFromIter)

that method should delete test suites, and remove its references in iteration and iteration test plan item

Parameters:

removeFromIter -

testSuites -

Returns:

exportCampaignToCSV

org.squashtest.tm.domain.campaign.export.CampaignExportCSVModel exportCampaignToCSV(Long campaignId,
                                                                                  String exportType)

given a campaign Id, returns a model. It's made of rows and cell, and have a row header, check the relevant methods. Note that the actual model will differ according to the export type : "L" (light), "S" (standard), "F" (full).

Parameters:

campaignId -

Returns:

getParentNodesAsStringList

List<String> getParentNodesAsStringList(Long elementId)

findAllCampaignIdsForMilestone

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

copyNodesToFolder

List<org.squashtest.tm.domain.campaign.CampaignLibraryNode> 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.campaign.CampaignLibrary,org.squashtest.tm.domain.campaign.CampaignFolder,org.squashtest.tm.domain.campaign.CampaignLibraryNode>

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.campaign.CampaignLibraryNode> 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.campaign.CampaignLibrary,org.squashtest.tm.domain.campaign.CampaignFolder,org.squashtest.tm.domain.campaign.CampaignLibraryNode>

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.campaign.CampaignLibrary,org.squashtest.tm.domain.campaign.CampaignFolder,org.squashtest.tm.domain.campaign.CampaignLibraryNode>

moveNodesToFolder

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

Specified by:

moveNodesToFolder in interface LibraryNavigationService<org.squashtest.tm.domain.campaign.CampaignLibrary,org.squashtest.tm.domain.campaign.CampaignFolder,org.squashtest.tm.domain.campaign.CampaignLibraryNode>

moveNodesToLibrary

void moveNodesToLibrary(long destinationId,
                      Long[] targetId)

Specified by:

moveNodesToLibrary in interface LibraryNavigationService<org.squashtest.tm.domain.campaign.CampaignLibrary,org.squashtest.tm.domain.campaign.CampaignFolder,org.squashtest.tm.domain.campaign.CampaignLibraryNode>

moveNodesToLibrary

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

Specified by:

moveNodesToLibrary in interface LibraryNavigationService<org.squashtest.tm.domain.campaign.CampaignLibrary,org.squashtest.tm.domain.campaign.CampaignFolder,org.squashtest.tm.domain.campaign.CampaignLibraryNode>

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.campaign.CampaignLibrary,org.squashtest.tm.domain.campaign.CampaignFolder,org.squashtest.tm.domain.campaign.CampaignLibraryNode>

Returns: