org.netbeans.modules.bugtracking.spi

Interface RepositoryProvider<R,Q,I>

Type Parameters:

R - the implementation specific repository type

Q - the implementation specific query type

I - the implementation specific issue type

public interface RepositoryProvider<R,Q,I>

Provides access to a bugtracking repository (server).

Since:

1.85

Field Summary

Fields

Modifier and Type	Field and Description
static String	EVENT_QUERY_LIST_CHANGED A query from this repository was saved or removed.
static String	EVENT_UNSUBMITTED_ISSUES_CHANGED The content of unsubmitted issues for the repository changes.

Method Summary

Modifier and Type	Method and Description
void	addPropertyChangeListener(R r, PropertyChangeListener listener) Add a PropertyChangeListener to the given repository.
boolean	canAttachFiles(R r) Determines whether it is possible to attach files to an Issue for the given repository.
I	createIssue(R r) Creates a new issue, not yet submitted, issue instance.
I	createIssue(R r, String summary, String description) Creates a new issue instance preset with the given summary and description.
Q	createQuery(R r) Creates a new query instance.
RepositoryController	getController(R r) Returns the RepositoryController for this repository.
Image	getIcon(R r) Returns the icon for this repository
RepositoryInfo	getInfo(R r) Returns the repository info or null in case the repository is new and not saved yet.
Collection<I>	getIssues(R r, String... ids) Returns issues with the given IDs.
Collection<Q>	getQueries(R r) Returns all named (already saved) queries.
void	removed(R r) Notifies that the given repository was removed.
void	removePropertyChangeListener(R r, PropertyChangeListener listener) Removes a PropertyChangeListener to the given repository.
Collection<I>	simpleSearch(R r, String criteria) Runs a query against the bugtracking repository to get all issues for which applies that the ID equals to or the summary contains the given criteria string.

Field Detail

EVENT_QUERY_LIST_CHANGED

static final String EVENT_QUERY_LIST_CHANGED

A query from this repository was saved or removed.

Since:

1.85

See Also:

Constant Field Values

EVENT_UNSUBMITTED_ISSUES_CHANGED

static final String EVENT_UNSUBMITTED_ISSUES_CHANGED

The content of unsubmitted issues for the repository changes.

Since:

1.85

See Also:

Constant Field Values

Method Detail

getInfo

RepositoryInfo getInfo(R r)

Returns the repository info or null in case the repository is new and not saved yet.

Parameters:

r - an implementation specific repository

Returns:

a RepositoryInfo

Since:

1.85

getIcon

Image getIcon(R r)

Returns the icon for this repository

Parameters:

r - an implementation specific repository

Returns:

icon

Since:

1.85

getIssues

Collection<I> getIssues(R r,
                        String... ids)

Returns issues with the given IDs.

Parameters:

r - an implementation specific repository

ids -

Returns:

issues with the given id-s

Since:

1.85

removed

void removed(R r)

Notifies that the given repository was removed. Release any bound resources if necessary.

Parameters:

r - an implementation specific repository

Since:

1.85

getController

RepositoryController getController(R r)

Returns the RepositoryController for this repository.

Parameters:

r - an implementation specific repository

Returns:

a controller for this repository

Since:

1.85

createQuery

Q createQuery(R r)

Creates a new query instance.

Parameters:

r - an implementation specific repository

Returns:

a new Query instance or null if it's not possible to access the repository.

Since:

1.85

See Also:

QueryProvider

createIssue

I createIssue(R r)

Creates a new issue, not yet submitted, issue instance.

Parameters:

r - an implementation specific repository

Returns:

return a new Issue instance or null if it's not possible to create an issue.

Since:

1.85

See Also:

IssueProvider

createIssue

I createIssue(R r,
              String summary,
              String description)

Creates a new issue instance preset with the given summary and description.

Parameters:

r - an implementation specific repository

summary -

description -

Returns:

return a new issue instance or null if it's not possible to create an issue.

Since:

1.85

See Also:

IssueProvider

getQueries

Collection<Q> getQueries(R r)

Returns all named (already saved) queries.

Parameters:

r - an implementation specific repository

Returns:

collection of queries

Since:

1.85

See Also:

QueryProvider.remove(java.lang.Object)

simpleSearch

Collection<I> simpleSearch(R r,
                           String criteria)

Runs a query against the bugtracking repository to get all issues for which applies that the ID equals to or the summary contains the given criteria string. The method is expected to return after the whole execution was handled.

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

Parameters:

r - an implementation specific repository

criteria -

Returns:

collection of issues

Since:

1.85

canAttachFiles

boolean canAttachFiles(R r)

Determines whether it is possible to attach files to an Issue for the given repository.

Note that in case this method returns true IssueProvider.attachFile(java.lang.Object, java.io.File, java.lang.String, boolean) has to be implemented as well.

Parameters:

r - an implementation specific repository

Returns:

true in case it is possible to attach files, otherwise false

Since:

1.85

See Also:

IssueProvider.attachFile(java.lang.Object, java.io.File, java.lang.String, boolean)

removePropertyChangeListener

void removePropertyChangeListener(R r,
                                  PropertyChangeListener listener)

Removes a PropertyChangeListener to the given repository.

Parameters:

r - an implementation specific repository

listener - a PropertyChangeListener

Since:

1.85

addPropertyChangeListener

void addPropertyChangeListener(R r,
                               PropertyChangeListener listener)

Add a PropertyChangeListener to the given repository.

Parameters:

r - an implementation specific repository

listener - a PropertyChangeListener

Since:

1.85