org.squashtest.csp.tm.service
Interface BugTrackersLocalService

All Known Implementing Classes:

BugTrackersLocalServiceImpl

public interface BugTrackersLocalService

Method Summary

void	attachIssue(IssueDetector bugged, String remoteIssueKey) Will attach an existing issue to the issue detector
BugTrackerStatus	checkBugTrackerStatus(Long projectId) same as checkBugTrackerStatus(Project), using the id of the project instead.
BugTrackerStatus	checkBugTrackerStatus(Project project) tests if the bugtracker is ready for use
org.squashtest.csp.core.bugtracker.domain.BTIssue	createIssue(IssueDetector entity, org.squashtest.csp.core.bugtracker.domain.BTIssue issue) adds a new Issue to the entity.
void	detachIssue(Long id) Will detach an existing issue from an issue detector
org.squashtest.csp.core.bugtracker.domain.BTProject	findRemoteProject(String name, org.squashtest.csp.core.bugtracker.domain.BugTracker bugTracker) returns an instance of the remote project.
FilteredCollectionHolder<List<IssueOwnership<BTIssueDecorator>>>	findSortedIssueOwnershipForIteration(Long iterId, CollectionSorting sorter) Given an Iteration, returns a list of linked BTIssue (not Issue).
FilteredCollectionHolder<List<IssueOwnership<BTIssueDecorator>>>	findSortedIssueOwnershipForTestCase(Long tcId, CollectionSorting sorter) Given a TestCase, returns a list of linked BTIssue (not Issue).
FilteredCollectionHolder<List<IssueOwnership<BTIssueDecorator>>>	findSortedIssueOwnershipsForCampaigns(Long campId, CollectionSorting 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).
FilteredCollectionHolder<List<IssueOwnership<BTIssueDecorator>>>	findSortedIssueOwnershipsforExecution(Long execId, CollectionSorting sorter) Given an Execution, returns a list of linked BTIssue (not Issue).
FilteredCollectionHolder<List<IssueOwnership<BTIssueDecorator>>>	findSortedIssueOwnerShipsForExecutionStep(Long stepId, CollectionSorting sorter) Given an ExecutionStep, returns a list of linked BTIssue (not Issue).
FilteredCollectionHolder<List<IssueOwnership<BTIssueDecorator>>>	findSortedIssueOwnershipsForTestSuite(Long testSuiteId, CollectionSorting sorter) Given a TestSuite, returns a list of linked BTIssue (not Issue).
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.csp.core.bugtracker.domain.BTIssue	getIssue(String issueKey, org.squashtest.csp.core.bugtracker.domain.BugTracker bugTracker) returns a remote issue using its key
List<org.squashtest.csp.core.bugtracker.domain.BTIssue>	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()
List<org.squashtest.csp.core.bugtracker.domain.Priority>	getRemotePriorities(org.squashtest.csp.core.bugtracker.domain.BugTracker bugTracker) returns the list of priorities .
void	setCredentials(String username, String password, org.squashtest.csp.core.bugtracker.domain.BugTracker bugTracker) sets the credentials of an user for authentication bugtracker-side.

Method Detail

createIssue

org.squashtest.csp.core.bugtracker.domain.BTIssue createIssue(IssueDetector entity,
                                                              org.squashtest.csp.core.bugtracker.domain.BTIssue 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

FilteredCollectionHolder<List<IssueOwnership<BTIssueDecorator>>> findSortedIssueOwnerShipsForExecutionStep(Long stepId,
                                                                                                           CollectionSorting 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 FilteredCollectionHolder containing a non-null but possibly empty list of IssueOwnership, sorted and filtered according to the CollectionSorting.

findSortedIssueOwnershipsforExecution

FilteredCollectionHolder<List<IssueOwnership<BTIssueDecorator>>> findSortedIssueOwnershipsforExecution(Long execId,
                                                                                                       CollectionSorting 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 FilteredCollectionHolder containing a non-null but possibly empty list of IssueOwnership, sorted and filtered according to the CollectionSorting.

findSortedIssueOwnershipForIteration

FilteredCollectionHolder<List<IssueOwnership<BTIssueDecorator>>> findSortedIssueOwnershipForIteration(Long iterId,
                                                                                                      CollectionSorting 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 FilteredCollectionHolder containing a non-null but possibly empty list of IssueOwnership, sorted and filtered according to the CollectionSorting.

findSortedIssueOwnershipsForCampaigns

FilteredCollectionHolder<List<IssueOwnership<BTIssueDecorator>>> findSortedIssueOwnershipsForCampaigns(Long campId,
                                                                                                       CollectionSorting 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 FilteredCollectionHolder containing a non-null but possibly empty list of IssueOwnership, sorted and filtered according to the CollectionSorting.

findSortedIssueOwnershipsForTestSuite

FilteredCollectionHolder<List<IssueOwnership<BTIssueDecorator>>> findSortedIssueOwnershipsForTestSuite(Long testSuiteId,
                                                                                                       CollectionSorting 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 FilteredCollectionHolder containing a non-null but possibly empty list of IssueOwnership, sorted and filtered according to the CollectionSorting.

findSortedIssueOwnershipForTestCase

FilteredCollectionHolder<List<IssueOwnership<BTIssueDecorator>>> findSortedIssueOwnershipForTestCase(Long tcId,
                                                                                                     CollectionSorting 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 FilteredCollectionHolder containing a non-null but possibly empty list of IssueOwnership, sorted and filtered according to the CollectionSorting.

checkBugTrackerStatus

BugTrackerStatus checkBugTrackerStatus(Project project)

tests if the bugtracker is ready for use

Parameters:

project - : the concerned Project

Returns:

the status of the bugtracker

checkBugTrackerStatus

BugTrackerStatus checkBugTrackerStatus(Long projectId)

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

Parameters:

projectId -

Returns:

setCredentials

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

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

findRemoteProject

org.squashtest.csp.core.bugtracker.domain.BTProject 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.

getRemotePriorities

List<org.squashtest.csp.core.bugtracker.domain.Priority> getRemotePriorities(org.squashtest.csp.core.bugtracker.domain.BugTracker bugTracker)

returns the list of priorities .

Parameters:

bugTracker - : the concerned BugTracker

Returns:

the list of priorities. An empty list is returned if none are found.

Throws:

org.squashtest.csp.core.bugtracker.core.BugTrackerManagerException - and subtypes.

getIssue

org.squashtest.csp.core.bugtracker.domain.BTIssue 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<org.squashtest.csp.core.bugtracker.domain.BTIssue> 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(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:

bugged - : the current issue holder

issueId - : the id of the issue in Squash TM