psdi.common.condition

Class CollectionRestrict

java.lang.Object

psdi.common.condition.CollectionRestrict

All Implemented Interfaces:

CustomCondition

public class CollectionRestrict
extends java.lang.Object
implements CustomCondition

Custom condition for security restrictions by collection (CollectionAuth). CollectionAuth has children in SecurityRestrict. The rows in SecurityRestrict point to a condition (COLLRESTRICT) with this class.

Constructor Summary

Constructors

Constructor and Description
CollectionRestrict()

Method Summary

Modifier and Type	Method and Description
boolean	evaluateCondition(MboRemote mbo, java.lang.Object param) Evaluate the condition.
java.lang.String	toWhereClause(java.lang.Object param, MboSetRemote msr) Convert the condition to a where clause.

Methods inherited from class java.lang.Object

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

Constructor Detail

CollectionRestrict

public CollectionRestrict()

Method Detail

evaluateCondition

public boolean evaluateCondition(MboRemote mbo,
                                 java.lang.Object param)
                          throws MXException,
                                 java.rmi.RemoteException

Evaluate the condition. This method has to be thread safe.

For data restrictions having a condition (SecurityRestrict other than object Qualified), the object framework will call this method for each Mbo and set the Mbo and MboValue flags appropriately.

Specified by:

evaluateCondition in interface CustomCondition

Parameters:

mbo - The mbo to be evaluated

param - Any object of parameter that is understood by the condition class. For data restrictions, this param is not used. To use it, some of the framework logic must be overridden in the Mbo.

Returns:

The result of the evaluation. For data restrictions, True means the restriction will be applied.

Throws:

MXException

java.rmi.RemoteException

See Also:

SecurityRestrict, Condition, Mbo.evaluateRestriction(psdi.mbo.DataRestriction), Mbo.evaluateCtrlConditions(java.util.HashSet), Mbo.evaluateCondition(java.lang.String, boolean)

toWhereClause

public java.lang.String toWhereClause(java.lang.Object param,
                                      MboSetRemote msr)
                               throws MXException,
                                      java.rmi.RemoteException

Convert the condition to a where clause. If the condition class will be used for "QUALIFIED" object security type, this method should return a where clause. If the condition should NOT be used for "QUALIFIED", it should throw an exception to indicate it is an error when attempted to be used. This method has to be thread safe.

For qualified object data restrictions (SecurityRestrict) having a condition type of Class, the object framework (MboSet) will call this method to construct the Where clause.

Specified by:

toWhereClause in interface CustomCondition

Parameters:

param - For data restrictions, this is not used by the object framework. To use param you must override some of the framework logic in your MboSet.

msr - The MboSet whose Where clause is being constructed

Returns:

The where clause that can be used to query the database

Throws:

MXException

java.rmi.RemoteException

See Also:

SecurityRestrict, Condition, MboSet.getQualifiedWhere()