public class BrowseFilter
extends java.lang.Object
implements java.io.Serializable
Modifier and Type | Class and Description |
---|---|
static class |
BrowseFilter.NameFilter
This filter class allows for the definition of one or more potential filters for a specific type id.
|
Constructor and Description |
---|
BrowseFilter() |
Modifier and Type | Method and Description |
---|---|
protected void |
addNameFilter(BrowseFilter.NameFilter filter) |
void |
addNameFilter(java.lang.String typeId,
java.lang.String... filters)
Adds one or more name filters for a specific type id.
|
boolean |
checkNameFilters(QualifiedPath path)
Returns whether or not the provided path passes the name filters defined on this browse filter.
|
java.lang.String[] |
getAllowedTypes()
Returns the type ids of the sub types allowed by the filter.
|
java.lang.String |
getContinuationPoint()
The continuation point is a system specific object that can be used to continue a browse, if the maximum return
size was previously reached.
|
int |
getMaxResults()
Returns the maximum number of values that should be returned.
|
BrowseFilter.NameFilter[] |
getNameFilters()
Returns the name filter conditions defined.
|
java.util.Map<java.lang.String,BrowseFilter.NameFilter> |
getNameFiltersAsMap()
Returns the name filters, but as a map, with the type id as the key.
|
int |
getOffset()
Returns the desired offset, which means to skip the first number of results that would match.
|
void |
setContinuationPoint(java.lang.String continuationPoint)
Sets the continuation point in order to continue a browse that was previously started and then limited.
|
void |
setMaxResults(int maxResults)
Sets the maximum number of results that should be returned.
|
void |
setNameFilters(BrowseFilter.NameFilter[] filters)
Defines the name filters that apply to this filter.
|
void |
setOffset(int offset)
Indicates that we wish to skip a certain number of results.
|
public java.lang.String[] getAllowedTypes()
public BrowseFilter.NameFilter[] getNameFilters()
public java.util.Map<java.lang.String,BrowseFilter.NameFilter> getNameFiltersAsMap()
public void setNameFilters(BrowseFilter.NameFilter[] filters)
protected void addNameFilter(BrowseFilter.NameFilter filter)
public void addNameFilter(java.lang.String typeId, java.lang.String... filters)
typeId
- filters
- public int getMaxResults()
public void setMaxResults(int maxResults)
public java.lang.String getContinuationPoint()
public void setContinuationPoint(java.lang.String continuationPoint)
public int getOffset()
public void setOffset(int offset)
public boolean checkNameFilters(QualifiedPath path)
path
-