public class Request extends Object implements Serializable
Modifier and Type | Class and Description |
---|---|
static class |
Request.Junction
Junction.
|
static class |
Request.Mode
The mode of the request
|
Constructor and Description |
---|
Request()
Constructor providing a new request.
|
Modifier and Type | Method and Description |
---|---|
void |
addClause(de.espirit.firstspirit.access.search.PatternClause clause)
Adds a clause to be matched for this request's search.
|
void |
addConstraint(de.espirit.firstspirit.access.search.TemplateConstraint constraint)
Adds a constraint to be fulfilled.
|
void |
addElementRestriction(Long id)
Adds a restriction to an element identified by its numerical id.
|
void |
addTemplateRestriction(Long id)
Add a restriction on a template identified by its numerical id.
|
Set<de.espirit.firstspirit.access.search.PatternClause> |
getClauses()
Provides the clauses to be matched for this request.
|
Set<de.espirit.firstspirit.access.search.TemplateConstraint> |
getConstraints()
Provides a set of constraints to be fulfilled for this request's matches.
|
Set<Long> |
getElementRestrictions()
Provides restrictions set on elements.
|
Request.Junction |
getJunction()
Provides the junction for clauses within this request.
|
Request.Mode |
getMode()
Provides the mode for matching.
|
Map<Long,Integer> |
getPermissions()
Provides the map of defined permissions which have to be matched.
|
Set<Store.Type> |
getStores()
Provides the store types to search.
|
Set<Long> |
getTemplateRestrictions()
Provides all defined restrictions on templates for this request.
|
boolean |
isCaseSensitive()
Indicates the matching to be case sensitive.
|
void |
setCaseSensitive(boolean value)
Set the request to be case sensitive or not.
|
void |
setJunction(Request.Junction junction)
Set the junction for clauses within this request.
|
void |
setMode(Request.Mode mode)
Sets the mode for matching.
|
void |
setPermission(User user,
int permission)
Sets the permissions for searched elements.
|
void |
setStores(Collection<Store.Type> stores)
Sets the store types to be searched with this request.
|
Pattern |
toPattern(de.espirit.firstspirit.access.search.PatternClause clause)
Create a matching pattern from a clause object.
|
public void setPermission(User user, int permission)
user
- The user.permission
- The permission to be matched.public Map<Long,Integer> getPermissions()
public Request.Junction getJunction()
public void setJunction(Request.Junction junction)
junction
- The junction.public Request.Mode getMode()
public void setMode(Request.Mode mode)
mode
- The mode.public boolean isCaseSensitive()
true
, if case sensitive.public void setCaseSensitive(boolean value)
value
- true
, to set case sensitive.public Set<Store.Type> getStores()
public void setStores(Collection<Store.Type> stores)
stores
- The store types.public Set<de.espirit.firstspirit.access.search.PatternClause> getClauses()
public void addClause(de.espirit.firstspirit.access.search.PatternClause clause)
clause
- A clause.public Set<de.espirit.firstspirit.access.search.TemplateConstraint> getConstraints()
public void addConstraint(de.espirit.firstspirit.access.search.TemplateConstraint constraint)
constraint
- A constraint.public Set<Long> getElementRestrictions()
public void addElementRestriction(Long id)
id
- The element id.public Set<Long> getTemplateRestrictions()
public void addTemplateRestriction(Long id)
id
- A template id.public Pattern toPattern(de.espirit.firstspirit.access.search.PatternClause clause)
clause
- A clause.Copyright © 2021 e-Spirit AG. All Rights Reserved. Build 5.2.210210