Class Request
java.lang.Object
de.espirit.firstspirit.access.search.Request
- All Implemented Interfaces:
Serializable
Container for defining a search request.
- Since:
- 4.0.17
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic enum
Junction.static enum
The mode of the request -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
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
Adds a restriction to an element identified by its numerical id.void
Add a restriction on a template identified by its numerical id.Set<de.espirit.firstspirit.access.search.PatternClause>
Provides the clauses to be matched for this request.Set<de.espirit.firstspirit.access.search.TemplateConstraint>
Provides a set of constraints to be fulfilled for this request's matches.Provides restrictions set on elements.Provides the junction for clauses within this request.getMode()
Provides the mode for matching.Provides the map of defined permissions which have to be matched.Provides the store types to search.Provides all defined restrictions on templates for this request.boolean
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.toPattern
(de.espirit.firstspirit.access.search.PatternClause clause) Create a matching pattern from a clause object.
-
Constructor Details
-
Request
public Request()Constructor providing a new request.- Since:
- 4.0.17
-
-
Method Details
-
setPermission
Sets the permissions for searched elements.- Parameters:
user
- The user.permission
- The permission to be matched.- Since:
- 4.1.7
-
getPermissions
Provides the map of defined permissions which have to be matched.- Returns:
- A map of permissions.
- Since:
- 4.1.7
-
getJunction
Provides the junction for clauses within this request.- Returns:
- The junction to use.
- Since:
- 4.0.17
-
setJunction
Set the junction for clauses within this request.- Parameters:
junction
- The junction.- Since:
- 4.0.17
-
getMode
Provides the mode for matching.- Returns:
- The mode.
- Since:
- 4.0.17
-
setMode
Sets the mode for matching.- Parameters:
mode
- The mode.- Since:
- 4.0.17
-
isCaseSensitive
public boolean isCaseSensitive()Indicates the matching to be case sensitive.- Returns:
true
, if case sensitive.- Since:
- 4.0.17
-
setCaseSensitive
public void setCaseSensitive(boolean value) Set the request to be case sensitive or not.- Parameters:
value
-true
, to set case sensitive.- Since:
- 4.0.17
-
getStores
Provides the store types to search.- Returns:
- A set of store types.
- Since:
- 4.0.17
-
setStores
Sets the store types to be searched with this request.- Parameters:
stores
- The store types.- Since:
- 4.1.7
-
getClauses
Provides the clauses to be matched for this request.- Returns:
- The clauses.
- Since:
- 4.0.17
-
addClause
public void addClause(de.espirit.firstspirit.access.search.PatternClause clause) Adds a clause to be matched for this request's search.- Parameters:
clause
- A clause.- Since:
- 4.0.17
-
getConstraints
Provides a set of constraints to be fulfilled for this request's matches.- Returns:
- A set of constraints.
- Since:
- 4.0.17
-
addConstraint
public void addConstraint(de.espirit.firstspirit.access.search.TemplateConstraint constraint) Adds a constraint to be fulfilled.- Parameters:
constraint
- A constraint.- Since:
- 4.0.17
-
getElementRestrictions
Provides restrictions set on elements.- Returns:
- A set of element ids.
- Since:
- 4.0.17
-
addElementRestriction
Adds a restriction to an element identified by its numerical id.- Parameters:
id
- The element id.- Since:
- 4.0.17
-
getTemplateRestrictions
Provides all defined restrictions on templates for this request.- Returns:
- A set of template ids.
- Since:
- 4.0.17
-
addTemplateRestriction
Add a restriction on a template identified by its numerical id.- Parameters:
id
- A template id.- Since:
- 4.0.17
-
toPattern
Create a matching pattern from a clause object.- Parameters:
clause
- A clause.- Returns:
- A pattern.
- Since:
- 4.0.17
-