org.netbeans.modules.bugtracking.spi

Interface QueryProvider<Q,I>

Type Parameters:

Q - the implementation specific query type

I - the implementation specific issue type

public interface QueryProvider<Q,I>

Provides access to a bugtracking query.

Since:

1.85

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	QueryProvider.IssueContainer<I> Notifies about refreshing progress and Issues retrieved by an Query.

Method Summary

Modifier and Type	Method and Description
boolean	canRemove(Q q) Determines whether it is possible to remove the given Query.
boolean	canRename(Q q) Determines whether it is possible to rename the given Query.
QueryController	getController(Q q) Returns the QueryController for this query
String	getDisplayName(Q q) Returns the queries display name
String	getTooltip(Q q) Returns the queries tooltip
void	refresh(Q q) Refreshes the given query.
void	remove(Q q) Removes the given query.
void	rename(Q q, String newName) Renames the given query.
void	setIssueContainer(Q q, QueryProvider.IssueContainer<I> c) Sets a QueryProvider.IssueContainer.

Method Detail

getDisplayName

String getDisplayName(Q q)

Returns the queries display name

Parameters:

q - the particular query instance

Returns:

the display name

Since:

1.85

getTooltip

String getTooltip(Q q)

Returns the queries tooltip

Parameters:

q - the particular query instance

Returns:

the tooltip

Since:

1.85

getController

QueryController getController(Q q)

Returns the QueryController for this query

Parameters:

q - the implementation specific query type

Returns:

a controller for the given query

Since:

1.85

canRemove

boolean canRemove(Q q)

Determines whether it is possible to remove the given Query.

Parameters:

q - the particular query instance

Returns:

true in case it is possible to remove the query, otherwise fasle

Since:

1.85

remove

void remove(Q q)

Removes the given query. This method may be called on any Query returned by RepositoryProvider.getQueries(java.lang.Object) in case QueryProvider.canRemove(java.lang.Object) returns true. After a remove it should not be returned by RepositoryProvider.getQueries(java.lang.Object) anymore.

Parameters:

q - the particular query instance

Since:

1.85

See Also:

RepositoryProvider.getQueries(java.lang.Object)

canRename

boolean canRename(Q q)

Determines whether it is possible to rename the given Query.

Parameters:

q - the particular query instance

Returns:

true in case it is possible to rename the query, otherwise fasle

Since:

1.85

rename

void rename(Q q,
            String newName)

Renames the given query.

Parameters:

q - the particular query instance

newName - new name

Since:

1.85

setIssueContainer

void setIssueContainer(Q q,
                       QueryProvider.IssueContainer<I> c)

Sets a QueryProvider.IssueContainer.

Parameters:

q - the particular query instance

c - a IssueContainer

refresh

void refresh(Q q)

Refreshes the given query.

Note that this call is made periodically by the infrastructure.

Parameters:

q - the particular query instance

Since:

1.85