org.netbeans.modules.bugtracking.spi

Interface IssueProvider<I>

Type Parameters:

I - the implementation specific issue type

public interface IssueProvider<I>

Provides access to a bugtracking Issue.

Since:

1.85

Field Summary

Fields

Modifier and Type	Field and Description
static String	EVENT_ISSUE_DATA_CHANGED Issue data were changed.
static String	EVENT_ISSUE_DELETED Issue ceased to exist.

Method Summary

Modifier and Type	Method and Description
void	addComment(I i, String comment, boolean close) Add a comment to this issue and close it as fixed eventually.
void	addPropertyChangeListener(I i, PropertyChangeListener listener) Add a PropertyChangeListener to the given issue.
void	attachFile(I i, File file, String description, boolean isPatch) Attach a file to this issue.
IssueController	getController(I i) Returns a controller for the given issue.
String	getDisplayName(I i) Returns the display name for the given issue.
String	getID(I i) Returns the unique ID for the given issue.
Collection<String>	getSubtasks(I i) Returns the ID-s of all issues where this one could be considered being superordinate to them.
String	getSummary(I i) Returns the summary for the given issue.
String	getTooltip(I i) Returns the tooltip for the given issue.
boolean	isFinished(I i) Determines if the issue is considered finished in the means of the particular implementation - e.g closed as fixed in case of bugzilla.
boolean	isNew(I i) Returns true if the issue isn't stored in a repository yet.
boolean	refresh(I i) Refreshes from the remote bugtracking repository the data for the given issue.
void	removePropertyChangeListener(I i, PropertyChangeListener listener) Remove a PropertyChangeListener from the given issue.

Field Detail

EVENT_ISSUE_DATA_CHANGED

static final String EVENT_ISSUE_DATA_CHANGED

Issue data were changed. Fire this to notify e.g. Issue nodes in Tasks Dashboard.

Since:

1.85

See Also:

Constant Field Values

EVENT_ISSUE_DELETED

static final String EVENT_ISSUE_DELETED

Issue ceased to exist. The Issue is entirely gone (e.g. deleted in remote repository) Fire this to notify e.g. the Tasks Dashboard.

Since:

1.85

See Also:

Constant Field Values

Method Detail

getDisplayName

String getDisplayName(I i)

Returns the display name for the given issue.

Parameters:

i - an implementation specific issue instance

Returns:

the display name for the given Issue

Since:

1.85

getTooltip

String getTooltip(I i)

Returns the tooltip for the given issue.

Parameters:

i - an implementation specific issue instance

Returns:

tooltip for the given Issue

Since:

1.85

getID

String getID(I i)

Returns the unique ID for the given issue. Might be null in case the issue is locally new.

Parameters:

i - an implementation specific issue instance

Returns:

id of the given Issue

Since:

1.85

getSubtasks

Collection<String> getSubtasks(I i)

Returns the ID-s of all issues where this one could be considered being superordinate to them. e.g. the blocks/depends relationship in Bugzilla, or sub-/parent-task in JIRA

Parameters:

i - an implementation specific issue instance

Returns:

id-s of subtasks for the given Issue

Since:

1.85

getSummary

String getSummary(I i)

Returns the summary for the given issue.

Parameters:

i - an implementation specific issue instance

Returns:

summary

Since:

1.85

isNew

boolean isNew(I i)

Returns true if the issue isn't stored in a repository yet. Otherwise false.

Parameters:

i - an implementation specific issue instance

Returns:

true in case the given Issue exists only locally and wasn't submitted yet.

Since:

1.85

isFinished

boolean isFinished(I i)

Determines if the issue is considered finished in the means of the particular implementation - e.g closed as fixed in case of bugzilla.

Parameters:

i - an implementation specific issue instance

Returns:

true if finished, otherwise false

Since:

1.85

refresh

boolean refresh(I i)

Refreshes from the remote bugtracking repository the data for the given issue.

In case an error appears during execution, the implementation should take care of the error handling, user notification etc.

Parameters:

i - an implementation specific issue instance

Returns:

true if the issue was refreshed, otherwise false

Since:

1.85

addComment

void addComment(I i,
                String comment,
                boolean close)

Add a comment to this issue and close it as fixed eventually. The method is expected to return after the whole execution was handled and the changes submitted to the remote repository.

In case an error appears during execution, the implementation should take care of the error handling, user notification etc.

Parameters:

i - an implementation specific issue instance

comment - a comment to be added to the issue

close - close the issue if true

Since:

1.85

attachFile

void attachFile(I i,
                File file,
                String description,
                boolean isPatch)

Attach a file to this issue. The method is expected to return after the whole execution was handled and the changes submitted to the remote repository.

In case an error appears during execution, the implementation should take care of the error handling, user notification etc.

Note that in case this functionality isn't available then RepositoryProvider.canAttachFiles(java.lang.Object) is expected to return false

Parameters:

i - an implementation specific issue instance

file - the to be attached file

description - description to be associated with the file

isPatch - true in case the given file is a patch, otherwise false

Since:

1.85

See Also:

RepositoryProvider.canAttachFiles(java.lang.Object)

getController

IssueController getController(I i)

Returns a controller for the given issue.

Parameters:

i - an implementation specific issue instance

Returns:

an IssueController for the given issue

Since:

1.85

removePropertyChangeListener

void removePropertyChangeListener(I i,
                                  PropertyChangeListener listener)

Remove a PropertyChangeListener from the given issue.

Parameters:

i - an implementation specific issue instance

listener - a PropertyChangeListener

Since:

1.85

addPropertyChangeListener

void addPropertyChangeListener(I i,
                               PropertyChangeListener listener)

Add a PropertyChangeListener to the given issue.

Parameters:

i - an implementation specific issue instance

listener - a PropertyChangeListener

Since:

1.85