Package org.ametys.plugins.odfweb.restrictions.rules

Class OdfOrgunitRestrictionRule

java.lang.Object

org.ametys.plugins.odfweb.restrictions.rules.OdfOrgunitRestrictionRule

All Implemented Interfaces:

OdfRestrictionRule

public class OdfOrgunitRestrictionRule
extends Object
implements OdfRestrictionRule

This implementation of OdfRestrictionRule restricts ODF to a orgunit and their child orgunits

Constructor Summary

Constructors

Constructor	Description
OdfOrgunitRestrictionRule(RootOrgUnitProvider ouProvider, String orgUnitId)	Constructor for ODF rule restriction on a orgunit

Method Summary

Modifier and Type	Method	Description
boolean	contains(Program program)	Determines if this program is part of this restriction
Expression	getExpression()	Translate the restriction into an expression that can be used for repository query.
Query	getQuery()	Translate the restriction into a Solr query that can be used for search.
boolean	hasOrgunitRestrictions()	Indicate if this restriction is related to orgunit

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

OdfOrgunitRestrictionRule

public OdfOrgunitRestrictionRule(RootOrgUnitProvider ouProvider,
 String orgUnitId)

Constructor for ODF rule restriction on a orgunit

Parameters:

ouProvider - The orgunits provider

orgUnitId - The id of orgunit

Method Details

getExpression

public Expression getExpression()

Description copied from interface: OdfRestrictionRule

Translate the restriction into an expression that can be used for repository query.

Specified by:

getExpression in interface OdfRestrictionRule

Returns:

The restriction expression

getQuery

public Query getQuery()

Description copied from interface: OdfRestrictionRule

Translate the restriction into a Solr query that can be used for search.

Specified by:

getQuery in interface OdfRestrictionRule

Returns:

The restriction query

contains

public boolean contains(Program program)

Description copied from interface: OdfRestrictionRule

Determines if this program is part of this restriction

Specified by:

contains in interface OdfRestrictionRule

Parameters:

program - The program

Returns:

true If the program is part of this restriction

hasOrgunitRestrictions

public boolean hasOrgunitRestrictions()

Description copied from interface: OdfRestrictionRule

Indicate if this restriction is related to orgunit

Specified by:

hasOrgunitRestrictions in interface OdfRestrictionRule

Returns:

true if it is the case