org.gatein.api.site

Class SiteQuery

java.lang.Object

org.gatein.api.site.SiteQuery

public class SiteQuery
extends Object

An immutable SiteQuery object that can be used to query sites. This object is created by using the builder SiteQuery.Builder.

Author:

Nick Scavelli

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SiteQuery.Builder The builder class responsible for building SiteQuery objects.

Method Summary

Methods

Modifier and Type	Method and Description
Filter<Site>	getFilter()
Pagination	getPagination()
EnumSet<SiteType>	getSiteTypes() The site types used for this query.
Sorting<Site>	getSorting()
boolean	isIncludeEmptySites() The flag indicates if the query should include/exclude sites that are empty.
SiteQuery	nextPage() Convenience method for creating a new SiteQuery with pagination set to the next page represented by by Pagination.getNext()
SiteQuery	previousPage() Convenience method for creating a new SiteQuery with pagination set to the previous page represented by by Pagination.getPrevious()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getSiteTypes

public EnumSet<SiteType> getSiteTypes()

The site types used for this query.

Returns:

the site types associated with this query.

isIncludeEmptySites

public boolean isIncludeEmptySites()

The flag indicates if the query should include/exclude sites that are empty. Empty sites generally have no navigation associated with them (hence cannot be viewed) which typically happens for spaces of a parent group. For example the space /platform is the parent group of /platform/administrators, however the /platform space should never be returned as a site in most cases.

Returns:

true if the query should return sites that are empty, false otherwise (default)

getFilter

public Filter<Site> getFilter()

getSorting

public Sorting<Site> getSorting()

getPagination

public Pagination getPagination()

nextPage

public SiteQuery nextPage()

Convenience method for creating a new SiteQuery with pagination set to the next page represented by by Pagination.getNext()

Returns:

a new SiteQuery with pagination set to the next page.

previousPage

public SiteQuery previousPage()

Convenience method for creating a new SiteQuery with pagination set to the previous page represented by by Pagination.getPrevious()

Returns:

a new SiteQuery with pagination set to the previous page.