org.squashtest.tm.service.bugtracker

Interface BugTrackersLocalService

All Known Implementing Classes:

BugTrackersLocalServiceImpl

@Transactional
public interface BugTrackersLocalService

Method Summary

Methods

Modifier and Type	Method and Description
void	attachIssue(org.squashtest.tm.domain.bugtracker.IssueDetector bugged, String remoteIssueKey) Will attach an existing issue to the issue detector
org.squashtest.tm.domain.servers.AuthenticationStatus	checkAuthenticationStatus(Long bugtrackerId) says whether the user is authenticated against that bugtracker regardless of the bindings with projects.
org.squashtest.tm.domain.servers.AuthenticationStatus	checkBugTrackerStatus(Long projectId) same as checkBugTrackerStatus(Project), using the id of the project instead.
org.squashtest.tm.domain.servers.AuthenticationStatus	checkBugTrackerStatus(org.squashtest.tm.domain.project.Project project) tests if the bugtracker is ready for use
org.squashtest.tm.bugtracker.definition.RemoteIssue	createIssue(org.squashtest.tm.domain.bugtracker.IssueDetector entity, org.squashtest.tm.bugtracker.definition.RemoteIssue issue) adds a new Issue to the entity.
org.squashtest.tm.bugtracker.definition.RemoteIssue	createReportIssueTemplate(String projectName, org.squashtest.csp.core.bugtracker.domain.BugTracker bugTracker) Must return ready-to-fill issue, ie with empty fields and its project configured with as many metadata as possible related to issue creation.
void	detachIssue(long id) Will detach an existing issue from an issue detector
org.squashtest.tm.domain.execution.Execution	findExecutionByIssueId(Long id)
List<org.squashtest.tm.domain.execution.Execution>	findExecutionsByRemoteIssue(String remoteid, String name)
org.squashtest.tm.domain.bugtracker.Issue	findIssueById(Long id)
List<org.squashtest.tm.domain.bugtracker.IssueOwnership<org.squashtest.tm.domain.bugtracker.RemoteIssueDecorator>>	findIssueOwnershipForTestCase(long testCaseId) Given a TestCase, returns a list of linked BTIssue (not Issue).
int	findNumberOfIssueForExecutionStep(Long testStepId) self-explanatory
int	findNumberOfIssueForItemTestPlanLastExecution(Long itemTestPlanId) self-explanatory
int	findNumberOfIssueForTestCase(Long id)
org.squashtest.tm.bugtracker.definition.RemoteProject	findRemoteProject(String name, org.squashtest.csp.core.bugtracker.domain.BugTracker bugTracker) returns an instance of the remote project.
org.squashtest.tm.core.foundation.collection.PagedCollectionHolder<List<org.squashtest.tm.domain.bugtracker.IssueOwnership<org.squashtest.tm.domain.bugtracker.RemoteIssueDecorator>>>	findSortedIssueOwnershipForCampaignFolder(Long cfId, org.squashtest.tm.core.foundation.collection.PagingAndSorting sorter) Given a CampaignFolder, returns a list of linked BTIssue (not Issue) for all campaigns, iterations etc this folder contains.
org.squashtest.tm.core.foundation.collection.PagedCollectionHolder<List<org.squashtest.tm.domain.bugtracker.IssueOwnership<org.squashtest.tm.domain.bugtracker.RemoteIssueDecorator>>>	findSortedIssueOwnershipForIteration(Long iterId, org.squashtest.tm.core.foundation.collection.PagingAndSorting sorter) Given an Iteration, returns a list of linked BTIssue (not Issue).
org.squashtest.tm.core.foundation.collection.PagedCollectionHolder<List<org.squashtest.tm.domain.bugtracker.IssueOwnership<org.squashtest.tm.domain.bugtracker.RemoteIssueDecorator>>>	findSortedIssueOwnershipForTestCase(Long tcId, org.squashtest.tm.core.foundation.collection.PagingAndSorting sorter) Given a TestCase, returns a list of linked BTIssue (not Issue).
org.squashtest.tm.core.foundation.collection.PagedCollectionHolder<List<org.squashtest.tm.domain.bugtracker.IssueOwnership<org.squashtest.tm.domain.bugtracker.RemoteIssueDecorator>>>	findSortedIssueOwnershipsForCampaign(Long campId, org.squashtest.tm.core.foundation.collection.PagingAndSorting sorter) Given an Campaign, returns a list of linked BTIssue (not Issue) To keep track of which IssueDetector owns which issue, the data are wrapped in a IssueOwnership (that just pair the informations together).
org.squashtest.tm.core.foundation.collection.PagedCollectionHolder<List<org.squashtest.tm.domain.bugtracker.IssueOwnership<org.squashtest.tm.domain.bugtracker.RemoteIssueDecorator>>>	findSortedIssueOwnershipsforExecution(Long execId, org.squashtest.tm.core.foundation.collection.PagingAndSorting sorter) Given an Execution, returns a list of linked BTIssue (not Issue).
org.squashtest.tm.core.foundation.collection.PagedCollectionHolder<List<org.squashtest.tm.domain.bugtracker.IssueOwnership<org.squashtest.tm.domain.bugtracker.RemoteIssueDecorator>>>	findSortedIssueOwnerShipsForExecutionStep(Long stepId, org.squashtest.tm.core.foundation.collection.PagingAndSorting sorter) Given an ExecutionStep, returns a list of linked BTIssue (not Issue).
org.squashtest.tm.core.foundation.collection.PagedCollectionHolder<List<org.squashtest.tm.domain.bugtracker.IssueOwnership<org.squashtest.tm.domain.bugtracker.RemoteIssueDecorator>>>	findSortedIssueOwnershipsForTestSuite(Long testSuiteId, org.squashtest.tm.core.foundation.collection.PagingAndSorting sorter) Given a TestSuite, returns a list of linked BTIssue (not Issue).
org.squashtest.tm.domain.testcase.TestCase	findTestCaseRelatedToIssue(Long issueId)
void	forwardAttachments(String remoteIssueKey, String bugtrackerName, List<org.squashtest.tm.bugtracker.definition.Attachment> attachments) Given a remote issue key, will ask the bugtracker to attach the attachments to that issue.
Object	forwardDelegateCommand(org.squashtest.tm.bugtracker.advanceddomain.DelegateCommand command, String bugtrackerName) forwards a DelegateCommand to a connector
org.squashtest.csp.core.bugtracker.spi.BugTrackerInterfaceDescriptor	getInterfaceDescriptor(org.squashtest.csp.core.bugtracker.domain.BugTracker bugTracker) An InterfaceDescriptor contains informations relevant to the generation of a view/GUI.
org.squashtest.tm.bugtracker.definition.RemoteIssue	getIssue(String issueKey, org.squashtest.csp.core.bugtracker.domain.BugTracker bugTracker) returns a remote issue using its key
List<org.squashtest.tm.domain.bugtracker.Issue>	getIssueList(String remoteid, String name)
List<? extends org.squashtest.tm.bugtracker.definition.RemoteIssue>	getIssues(List<String> issueKeyList, org.squashtest.csp.core.bugtracker.domain.BugTracker bugTracker) returns a list of BTIssu corresponding to the given string keys
URL	getIssueUrl(String btIssueId, org.squashtest.csp.core.bugtracker.domain.BugTracker bugTracker) Gets the url of a remote Issue given its Id
Set<String>	getProviderKinds()
void	setCredentials(String username, String password, org.squashtest.csp.core.bugtracker.domain.BugTracker bugTracker) sets the credentials of an user for authentication bugtracker-side.
void	setCredentials(String username, String password, Long bugtrackerId) Same as setCredentials(String, String, BugTracker), but the bugtracker is identified by its id.

Method Detail

createIssue

org.squashtest.tm.bugtracker.definition.RemoteIssue createIssue(org.squashtest.tm.domain.bugtracker.IssueDetector entity,
                                                              org.squashtest.tm.bugtracker.definition.RemoteIssue issue)

adds a new Issue to the entity. The entity must implement IssueDetector.

Parameters:

entityId - : the id of that entity.

entityClass - : the actual class of that entity, that implements IssueDetector.

issue - : the issue to add

Returns:

the BTIssue corresponding to the bug remotely created

getIssueUrl

URL getIssueUrl(String btIssueId,
              org.squashtest.csp.core.bugtracker.domain.BugTracker bugTracker)

Gets the url of a remote Issue given its Id

Parameters:

btIssueId - the id of that issue

bugTracker - : the concerned BugTracker

Returns:

the URL where you may find that issue.

getInterfaceDescriptor

org.squashtest.csp.core.bugtracker.spi.BugTrackerInterfaceDescriptor getInterfaceDescriptor(org.squashtest.csp.core.bugtracker.domain.BugTracker bugTracker)

An InterfaceDescriptor contains informations relevant to the generation of a view/GUI. See the class for more details.

Parameters:

bugTracker - the concerned BugTracker

Returns:

an InterfaceDescriptor.

findSortedIssueOwnerShipsForExecutionStep

org.squashtest.tm.core.foundation.collection.PagedCollectionHolder<List<org.squashtest.tm.domain.bugtracker.IssueOwnership<org.squashtest.tm.domain.bugtracker.RemoteIssueDecorator>>> findSortedIssueOwnerShipsForExecutionStep(Long stepId,
                                                                                                                                                                                                                               org.squashtest.tm.core.foundation.collection.PagingAndSorting sorter)

Given an ExecutionStep, returns a list of linked BTIssue (not Issue).

To keep track of which IssueDetector owns which issue, the data are wrapped in a IssueOwnership (that just pair the informations together).

Parameters:

stepId - of which we need to get the issues,

sorter - that tells us how we should sort and filter the data

Returns:

a PagedCollectionHolder containing a non-null but possibly empty list of IssueOwnership, sorted and filtered according to the PagingAndSorting.

findSortedIssueOwnershipsforExecution

org.squashtest.tm.core.foundation.collection.PagedCollectionHolder<List<org.squashtest.tm.domain.bugtracker.IssueOwnership<org.squashtest.tm.domain.bugtracker.RemoteIssueDecorator>>> findSortedIssueOwnershipsforExecution(Long execId,
                                                                                                                                                                                                                           org.squashtest.tm.core.foundation.collection.PagingAndSorting sorter)

Given an Execution, returns a list of linked BTIssue (not Issue).

To keep track of which IssueDetector owns which issue, the data are wrapped in a IssueOwnership (that just pair the informations together).

Parameters:

execId - of which we need to get the issues,

sorter - that tells us how we should sort and filter the data

Returns:

a PagedCollectionHolder containing a non-null but possibly empty list of IssueOwnership, sorted and filtered according to the PagingAndSorting.

findSortedIssueOwnershipForIteration

org.squashtest.tm.core.foundation.collection.PagedCollectionHolder<List<org.squashtest.tm.domain.bugtracker.IssueOwnership<org.squashtest.tm.domain.bugtracker.RemoteIssueDecorator>>> findSortedIssueOwnershipForIteration(Long iterId,
                                                                                                                                                                                                                          org.squashtest.tm.core.foundation.collection.PagingAndSorting sorter)

Given an Iteration, returns a list of linked BTIssue (not Issue).

To keep track of which IssueDetector owns which issue, the data are wrapped in a IssueOwnership (that just pair the informations together).

Parameters:

iterId - of which we need to get the issues,

sorter - that tells us how we should sort and filter the data

Returns:

a PagedCollectionHolder containing a non-null but possibly empty list of IssueOwnership, sorted and filtered according to the PagingAndSorting.

findSortedIssueOwnershipsForCampaign

org.squashtest.tm.core.foundation.collection.PagedCollectionHolder<List<org.squashtest.tm.domain.bugtracker.IssueOwnership<org.squashtest.tm.domain.bugtracker.RemoteIssueDecorator>>> findSortedIssueOwnershipsForCampaign(Long campId,
                                                                                                                                                                                                                          org.squashtest.tm.core.foundation.collection.PagingAndSorting sorter)

Given an Campaign, returns a list of linked BTIssue (not Issue)

To keep track of which IssueDetector owns which issue, the data are wrapped in a IssueOwnership (that just pair the informations together).

Parameters:

campId - of which we need to get the issues,

sorter - that tells us how we should sort and filter the data

Returns:

a PagedCollectionHolder containing a non-null but possibly empty list of IssueOwnership, sorted and filtered according to the PagingAndSorting.

findSortedIssueOwnershipsForTestSuite

org.squashtest.tm.core.foundation.collection.PagedCollectionHolder<List<org.squashtest.tm.domain.bugtracker.IssueOwnership<org.squashtest.tm.domain.bugtracker.RemoteIssueDecorator>>> findSortedIssueOwnershipsForTestSuite(Long testSuiteId,
                                                                                                                                                                                                                           org.squashtest.tm.core.foundation.collection.PagingAndSorting sorter)

Given a TestSuite, returns a list of linked BTIssue (not Issue).

To keep track of which IssueDetector owns which issue, the data are wrapped in a IssueOwnership (that just pair the informations together).

Parameters:

testSuiteId - for which we need to get the issues,

sorter - that tells us how we should sort and filter the data

Returns:

a PagedCollectionHolder containing a non-null but possibly empty list of IssueOwnership, sorted and filtered according to the PagingAndSorting.

findSortedIssueOwnershipForTestCase

org.squashtest.tm.core.foundation.collection.PagedCollectionHolder<List<org.squashtest.tm.domain.bugtracker.IssueOwnership<org.squashtest.tm.domain.bugtracker.RemoteIssueDecorator>>> findSortedIssueOwnershipForTestCase(Long tcId,
                                                                                                                                                                                                                         org.squashtest.tm.core.foundation.collection.PagingAndSorting sorter)

Given a TestCase, returns a list of linked BTIssue (not Issue).

To keep track of which IssueDetector owns which issue, the data are wrapped in a IssueOwnership (that just pair the informations together).

Parameters:

testCase - id for which we need to get the issues,

sorter - that tells us how we should sort and filter the data

Returns:

a PagedCollectionHolder containing a non-null but possibly empty list of IssueOwnership, sorted and filtered according to the PagingAndSorting.

findSortedIssueOwnershipForCampaignFolder

org.squashtest.tm.core.foundation.collection.PagedCollectionHolder<List<org.squashtest.tm.domain.bugtracker.IssueOwnership<org.squashtest.tm.domain.bugtracker.RemoteIssueDecorator>>> findSortedIssueOwnershipForCampaignFolder(Long cfId,
                                                                                                                                                                                                                               org.squashtest.tm.core.foundation.collection.PagingAndSorting sorter)

Given a CampaignFolder, returns a list of linked BTIssue (not Issue) for all campaigns, iterations etc this folder contains.

To keep track of which IssueDetector owns which issue, the data are wrapped in a IssueOwnership (that just pair the informations together).

Parameters:

cfId - for which we need to get the issues,

sorter - that tells us how we should sort and filter the data

Returns:

a PagedCollectionHolder containing a non-null but possibly empty list of IssueOwnership, sorted and filtered according to the PagingAndSorting.

findIssueOwnershipForTestCase

List<org.squashtest.tm.domain.bugtracker.IssueOwnership<org.squashtest.tm.domain.bugtracker.RemoteIssueDecorator>> findIssueOwnershipForTestCase(long testCaseId)

Given a TestCase, returns a list of linked BTIssue (not Issue).

To keep track of which IssueDetector owns which issue, the data are wrapped in a IssueOwnership (that just pair the informations together).

Parameters:

testCase - id for which we need to get the issues,

Returns:

a non-null but possibly empty list of IssueOwnership,

checkBugTrackerStatus

org.squashtest.tm.domain.servers.AuthenticationStatus checkBugTrackerStatus(org.squashtest.tm.domain.project.Project project)

tests if the bugtracker is ready for use

Parameters:

project - : the concerned Project

Returns:

the status of the bugtracker

checkBugTrackerStatus

org.squashtest.tm.domain.servers.AuthenticationStatus checkBugTrackerStatus(Long projectId)

same as checkBugTrackerStatus(Project), using the id of the project instead.

Parameters:

projectId -

Returns:

checkAuthenticationStatus

org.squashtest.tm.domain.servers.AuthenticationStatus checkAuthenticationStatus(Long bugtrackerId)

says whether the user is authenticated against that bugtracker regardless of the bindings with projects.

Parameters:

bugtracker -

Returns:

setCredentials

void setCredentials(String username,
                  String password,
                  org.squashtest.csp.core.bugtracker.domain.BugTracker bugTracker)
                    throws org.squashtest.csp.core.bugtracker.core.BugTrackerRemoteException

sets the credentials of an user for authentication bugtracker-side.

Parameters:

username -

password -

bugTracker - : the concerned BugTracker

Throws:

org.squashtest.csp.core.bugtracker.core.BugTrackerRemoteException - if the credentials are wrong

setCredentials

void setCredentials(String username,
                  String password,
                  Long bugtrackerId)
                    throws org.squashtest.csp.core.bugtracker.core.BugTrackerRemoteException

Same as setCredentials(String, String, BugTracker), but the bugtracker is identified by its id.

Parameters:

username -

password -

bugtrackerId -

Throws:

org.squashtest.csp.core.bugtracker.core.BugTrackerRemoteException

findRemoteProject

org.squashtest.tm.bugtracker.definition.RemoteProject findRemoteProject(String name,
                                                                      org.squashtest.csp.core.bugtracker.domain.BugTracker bugTracker)

returns an instance of the remote project.

Parameters:

name - : the name of the project.

bugTracker - : the concerned BugTracker

Returns:

the project filled with users and versions if found.

createReportIssueTemplate

org.squashtest.tm.bugtracker.definition.RemoteIssue createReportIssueTemplate(String projectName,
                                                                            org.squashtest.csp.core.bugtracker.domain.BugTracker bugTracker)

Must return ready-to-fill issue, ie with empty fields and its project configured with as many metadata as possible related to issue creation.

Parameters:

projectName -

BugTracker - bugTracker

Returns:

getIssue

org.squashtest.tm.bugtracker.definition.RemoteIssue getIssue(String issueKey,
                                                           org.squashtest.csp.core.bugtracker.domain.BugTracker bugTracker)

returns a remote issue using its key

Parameters:

issueKey -

bugTracker - : the concerned BugTracker

Returns:

a remote issue

getIssues

List<? extends org.squashtest.tm.bugtracker.definition.RemoteIssue> getIssues(List<String> issueKeyList,
                                                                            org.squashtest.csp.core.bugtracker.domain.BugTracker bugTracker)

returns a list of BTIssu corresponding to the given string keys

Parameters:

issueKeyList - the remote issue key list

bugTracker - : the concerned BugTracker

Returns:

a BTIssue list

attachIssue

void attachIssue(org.squashtest.tm.domain.bugtracker.IssueDetector bugged,
               String remoteIssueKey)

Will attach an existing issue to the issue detector

Parameters:

bugged - : the future issue holder

remoteIssueKey - : the identificator of the issue in the BT

getProviderKinds

Set<String> getProviderKinds()

Returns:

the list of all bugtracker kinds available

detachIssue

void detachIssue(long id)

Will detach an existing issue from an issue detector

Parameters:

issueId - : the id of the issue in Squash TM

forwardAttachments

void forwardAttachments(String remoteIssueKey,
                      String bugtrackerName,
                      List<org.squashtest.tm.bugtracker.definition.Attachment> attachments)

Given a remote issue key, will ask the bugtracker to attach the attachments to that issue. In order to prevent possible conflicts (multiple issue may have the same id if defined on different bugtrackers) the bugtracker name is required too.

Parameters:

remoteIssueKey -

attachments -

forwardDelegateCommand

Object forwardDelegateCommand(org.squashtest.tm.bugtracker.advanceddomain.DelegateCommand command,
                            String bugtrackerName)

forwards a DelegateCommand to a connector

Parameters:

command -

Returns:

findNumberOfIssueForTestCase

int findNumberOfIssueForTestCase(Long id)

findNumberOfIssueForItemTestPlanLastExecution

int findNumberOfIssueForItemTestPlanLastExecution(Long itemTestPlanId)

self-explanatory

findNumberOfIssueForExecutionStep

int findNumberOfIssueForExecutionStep(Long testStepId)

self-explanatory

findTestCaseRelatedToIssue

org.squashtest.tm.domain.testcase.TestCase findTestCaseRelatedToIssue(Long issueId)

findIssueById

org.squashtest.tm.domain.bugtracker.Issue findIssueById(Long id)

findExecutionsByRemoteIssue

List<org.squashtest.tm.domain.execution.Execution> findExecutionsByRemoteIssue(String remoteid,
                                                                             String name)

getIssueList

List<org.squashtest.tm.domain.bugtracker.Issue> getIssueList(String remoteid,
                                                           String name)

findExecutionByIssueId

org.squashtest.tm.domain.execution.Execution findExecutionByIssueId(Long id)