ome.services.graphs

Interface GraphPolicyRulePredicate

All Known Implementing Classes:

GroupPredicate, PermissionsPredicate

public interface GraphPolicyRulePredicate

A plug-in for graph policy rule matches whereby an object may be matched against named values.

Since:

5.1.3

Author:

m.t.b.carroll@dundee.ac.uk

Method Summary

Methods

Modifier and Type	Method and Description
String	getName()
boolean	isMatch(GraphPolicy.Details object, String parameter) If this predicate is satisfied by the given object.
void	noteDetails(org.hibernate.Session session, IObject object, String realClass, long id) Once this instance is submitted to GraphPolicy#registerPredicate(GraphPolicyPredicate) then this method is called by GraphPolicy.noteDetails(org.hibernate.Session, IObject, String, long).

Method Detail

getName

String getName()

Returns:

the name of this predicate

noteDetails

void noteDetails(org.hibernate.Session session,
               IObject object,
               String realClass,
               long id)

Once this instance is submitted to GraphPolicy#registerPredicate(GraphPolicyPredicate) then this method is called by GraphPolicy.noteDetails(org.hibernate.Session, IObject, String, long).

Parameters:

session - the Hibernate session, for obtaining more information about the object

object - an unloaded model object that may satisfy this predicate

realClass - the real class name of the object

id - the ID of the object

isMatch

boolean isMatch(GraphPolicy.Details object,
              String parameter)
                throws GraphException

If this predicate is satisfied by the given object.

Parameters:

object - a model object

parameter - the parameter that the object must match

Returns:

if the object satisfies this predicate

Throws:

GraphException - if the predicate could not be tested