Package com.polarion.alm.tracker

Interface ISavedQueriesManager

public interface ISavedQueriesManager

Method Summary

Modifier and Type	Method	Description
List<SavedQuery>	getSavedQueries(IProject project, IUser user)	Returns merged saved queries defined for specified user, project and global.
void	removeSavedQuery(int scope, IProject project, IUser user, String name)
void	saveGlobalQuery(String name, String query)
void	saveProjectQuery(IProject project, String name, String query)
void	saveQuery(int scope, IProject project, IUser user, String name, String query)
void	saveUserDefaultQuery(IUser user, String scope, String query)
void	saveUserQuery(IUser user, String name, String query)

Method Details

getSavedQueries

@NotNull
List<SavedQuery> getSavedQueries(@Nullable
 IProject project,
 @Nullable
 IUser user)

Returns merged saved queries defined for specified user, project and global.

Parameters:

project - - can be null

user - - can be null

Returns:

List of SavedQuery

saveQuery

void saveQuery(int scope,
 IProject project,
 IUser user,
 String name,
 String query)

Parameters:

scope - - as defined in SavedQuery

project -

user -

name -

query -

Throws:

IllegalArgumentException - when project is null for scope = SavedQuery.SCOPE_PROJECT

saveGlobalQuery

void saveGlobalQuery(String name,
 String query)

saveProjectQuery

void saveProjectQuery(IProject project,
 String name,
 String query)

saveUserQuery

void saveUserQuery(IUser user,
 String name,
 String query)

saveUserDefaultQuery

void saveUserDefaultQuery(@NotNull
 IUser user,
 @NotNull
 String scope,
 @NotNull
 String query)

Parameters:

user - - user for who the query will be saved

scope - - string which represents a scope for which the query will be made default

query - - query itself

Since:

3.10.0

removeSavedQuery

void removeSavedQuery(int scope,
 IProject project,
 IUser user,
 String name)

Parameters:

scope - - as defined in SavedQuery

project -

user -

name -

Throws:

IllegalArgumentException - when project is null for scope = SavedQuery.SCOPE_PROJECT