com.segue.scc.published.api.issuetracking

Interface IssueTrackingProfile

All Known Subinterfaces:

IssueTrackingProfile

public interface IssueTrackingProfile

The profile is the implementation of an integration to a foreign issue tracking system. Its name will be provided to the user when creating such a profile. It acts as a factory for issues. NOTE: Use IssueTrackingProfile to enabling a generic configuration GUI

Method Summary

Modifier and Type	Method and Description
void	fieldChanged(IssueTrackingField field) Called when a field with dependent fields has changed to reload the options of those dependent fields.
Issue	getIssue(java.lang.String id) Get the issue with the given identifier.
ProductsIssueStatisticEntry[]	getIssueStatistics() Get Statistics about the issues.
java.lang.String	getName() This name will be shown to the user (when selecting a special profile implementation) AND it will be used internally.
java.lang.String[]	getPossibleStates()
java.lang.String[][]	getStates(java.lang.String[] ids)
Issue	newIssue() This is a factory method for creating a specific Issue object, however the issue doesn't need to exist in the foreign issue tracking system already.
Issue	newIssue(java.lang.String issueType) This is for future use and can be left empty.

Method Detail

newIssue

Issue newIssue(java.lang.String issueType)
        throws IssueTrackingProfileException

This is for future use and can be left empty.

Throws:

IssueTrackingProfileException

newIssue

Issue newIssue()
        throws IssueTrackingProfileException

This is a factory method for creating a specific Issue object, however the issue doesn't need to exist in the foreign issue tracking system already. This method may also pre-fill some default data.

Returns:

A new Issue object for the specific profile.

Throws:

IssueTrackingProfileException - on any problem that occurs.

fieldChanged

void fieldChanged(IssueTrackingField field)
           throws IssueTrackingProfileException

Called when a field with dependent fields has changed to reload the options of those dependent fields. For example if the enumeration field "product" has a dependent enumeration field "version". Each time the value of "product" changes the selectable values for the field "version" can be changed in this method.

Parameters:

field - The field that was changed.

Throws:

IssueTrackingProfileException

getStates

java.lang.String[][] getStates(java.lang.String[] ids)
                        throws IssueTrackingProfileException

Parameters:

ids - Array of requested issue IDs.

Returns:

state info of requested issues [0] id, [1] state, [2] timemillis (changedAt), [3] synopsis, [4] priority.

Throws:

IssueTrackingProfileException

getPossibleStates

java.lang.String[] getPossibleStates()
                              throws IssueTrackingProfileException

Returns:

all states an issue may have in this profile.

Throws:

IssueTrackingProfileException

getIssue

Issue getIssue(java.lang.String id)
        throws IssueTrackingProfileException

Get the issue with the given identifier.

Parameters:

id - The ID of the issue in the integrated issue tracking tool.

Returns:

Issue with the given ID.

Throws:

IssueTrackingProfileException

getName

java.lang.String getName()

This name will be shown to the user (when selecting a special profile implementation) AND it will be used internally. It must be unique for all IssueTrackingProfiles.

getIssueStatistics

ProductsIssueStatisticEntry[] getIssueStatistics()
                                          throws IssueTrackingProfileException

Get Statistics about the issues. This method finds out how many open, fixed, etc. issues there are.

Returns:

if this is not supported, null can be returned.

Throws:

IssueTrackingProfileException - if an error occurs.