|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.sonar.api.web.Filter
public final class Filter
Definition of a filter.
Its name can be retrieved using the i18n mechanism, using the keys "filter.<id>.name".
Field Summary | |
---|---|
static String |
LIST
|
static String |
TREEMAP
|
Method Summary | |
---|---|
Filter |
add(Criterion criterion)
Add a Criterion to the list used to narrow down the results of this Filter . |
Filter |
add(FilterColumn column)
Add a FilterColumn to the list of columns displayed by this Filter . |
static Filter |
create()
Creates a new Filter . |
List<FilterColumn> |
getColumns()
Get the list of FilterColumn displayed by this Filter . |
List<Criterion> |
getCriteria()
Get the list of Criterion used to narrow down the results of this Filter . |
String |
getDisplayAs()
Get the type of display used by this Filter . |
int |
getPageSize()
Get the size of a page displayed this Filter . |
boolean |
isFavouritesOnly()
The Filter can be configured to return only favourites. |
Filter |
setDisplayAs(String displayAs)
Set the type of display used by this Filter . |
Filter |
setFavouritesOnly(boolean favouritesOnly)
The Filter can be configured to return only favourites. |
Filter |
setPageSize(int pageSize)
Set the size of a page displayed this Filter . |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String LIST
public static final String TREEMAP
Method Detail |
---|
public static Filter create()
Filter
.
public List<Criterion> getCriteria()
Criterion
used to narrow down the results of this Filter
.
public Filter add(Criterion criterion)
Criterion
to the list used to narrow down the results of this Filter
.
public List<FilterColumn> getColumns()
FilterColumn
displayed by this Filter
.
public Filter add(FilterColumn column)
FilterColumn
to the list of columns displayed by this Filter
.
public boolean isFavouritesOnly()
Filter
can be configured to return only favourites.
true
if favourites only are returnedpublic Filter setFavouritesOnly(boolean favouritesOnly)
Filter
can be configured to return only favourites.
public String getDisplayAs()
Filter
.
Can be either #LIST
or #TREEMAP
public Filter setDisplayAs(String displayAs)
Filter
.
Can be either #LIST
or #TREEMAP
IllegalArgumentException
- if displayAs
is not #LIST
or #TREEMAP
public int getPageSize()
Filter
.
The page size is between 20
and 200
(included)
public Filter setPageSize(int pageSize)
Filter
.
The page size should be between 20
and 200
(included)
IllegalArgumentException
- if pageSize
is not lower than 20
or greater than 200
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |