Package ch.tocco.nice2.persist.entity.api.constriction

Interface ConstrictionManager

All Known Implementing Classes:

ConstrictionManagerImpl

public interface ConstrictionManager

Constrictions are contributed query "extensions". The can be used to constrict grids, selections, ... by logic (but not by permissions). WARNING: Never use constrictions if you want to hide "important" data. That's the task of ACL!

Method Summary

Modifier and Type	Method	Description
QueryBuilder	extendQueryWithConstriction(QueryBuilder queryBuilder, String constriction)	Extend an existing QueryBuilder with a condition from a constriction
QueryBuilder	extendQueryWithConstriction(QueryBuilder queryBuilder, String constriction, Map<String,String> params)	Extend an existing QueryBuilder with a condition from a constriction
@Nullable Constriction	getConstriction(String name)
Constriction	getConstriction(String name, Map<String,String> params)
void	setConstriction(String name, Constriction constriction)	Set a constriction.

Method Details

getConstriction

@Nullable
@Nullable Constriction getConstriction(String name)

getConstriction

Constriction getConstriction(String name,
 Map<String,String> params)

extendQueryWithConstriction

QueryBuilder extendQueryWithConstriction(QueryBuilder queryBuilder,
 String constriction)
                                  throws PersistException

Extend an existing QueryBuilder with a condition from a constriction

Parameters:

constriction - constriction id

Returns:

the QueryBuilder

Throws:

PersistException

extendQueryWithConstriction

QueryBuilder extendQueryWithConstriction(QueryBuilder queryBuilder,
 String constriction,
 Map<String,String> params)
                                  throws PersistException

Extend an existing QueryBuilder with a condition from a constriction

Parameters:

constriction - constriction id

params - params for constriction

Returns:

the QueryBuilder

Throws:

PersistException

setConstriction

void setConstriction(String name,
 Constriction constriction)

Set a constriction. If there already exists a constriction with the given name, it will be replaced.

Parameters:

name - The name of the constriction.

constriction - The constriction (query where clause)