| Package | Description |
|---|---|
| org.sakaiproject.entitybroker.entityprovider.search |
| Modifier and Type | Method and Description |
|---|---|
Restriction |
Search.getRestrictionByProperties(String[] properties)
Finds if there are any search restrictions with one of the given properties,
if so it returns the first of the found restriction,
otherwise returns null
|
Restriction |
Search.getRestrictionByProperty(String property)
Convenient method to find restrictions by their property,
if there happens to be more than one restriction with a property then
only the first one will be returned (since that is an invalid state)
|
Restriction[] |
Search.getRestrictions()
Restrictions define limitations on the results of a search, e.g. propertyA > 100 or property B = 'jump'
You can add as many restrictions as you like and they will be applied in the array order |
| Modifier and Type | Method and Description |
|---|---|
void |
Search.addRestriction(Restriction restriction) |
void |
Search.setRestrictions(Restriction[] restrictions) |
| Constructor and Description |
|---|
Search(Restriction restriction)
Defines a search which defines only a single restriction,
defaults to AND restriction comparison and returning all results
|
Search(Restriction[] restrictions)
Defines a search which defines only restrictions,
defaults to AND restriction comparisons and returning all results
|
Search(Restriction[] restrictions,
Order order)
Defines a search which defines restrictions and return ordering,
defaults to AND restriction comparisons and returning all results
|
Search(Restriction[] restrictions,
Order[] orders)
Defines a search which defines restrictions and return ordering,
defaults to AND restriction comparisons and returning all results
|
Search(Restriction[] restrictions,
Order[] orders,
long start,
long limit)
Defines a search which defines restrictions and return ordering and limits the returns,
defaults to AND restriction comparisons
|
Search(Restriction[] restrictions,
Order[] orders,
long start,
long limit,
boolean conjunction)
Defines a search which defines restrictions and return ordering and limits the returns,
also specifies the types of restriction comparisons (AND or OR)
|
Search(Restriction[] restrictions,
Order order,
long start,
long limit)
Defines a search which defines restrictions and return ordering and limits the returns,
defaults to AND restriction comparisons
|
Search(Restriction[] restrictions,
Order order,
long start,
long limit,
boolean conjunction)
Defines a search which defines restrictions and return ordering and limits the returns,
also specifies the types of restriction comparisons (AND or OR)
|
Search(Restriction restriction,
Order order)
Defines a search which defines only a single restriction and returns all items,
defaults to AND restriction comparisons
|
Search(Restriction restriction,
Order order,
long start,
long limit)
Defines a search which defines only a single restriction and limits the returns,
defaults to AND restriction comparisons
|
Copyright © 2003–2022 Sakai Project. All rights reserved.