org.jasig.portal.layout.dlm.providers
Class GroupMembershipEvaluator

java.lang.Object
  org.jasig.portal.layout.dlm.Evaluator
      org.jasig.portal.layout.dlm.providers.GroupMembershipEvaluator

public class GroupMembershipEvaluator
extends Evaluator

Answers isApplicable() in the affirmative if the user represented by the passed in IPerson is a member of the group whose name is passed to the constructor of this class. Added support for a 'deepMemberOf' mode, from 2.5 patches (UP-1284) and cache group key rather than the group itself (UP-1532). d.e 2006/12/19.

Since:

uPortal 2.5

Version:

$Revision: 19776 $ $Date: 2010-01-14 16:17:21 -0600 (Thu, 14 Jan 2010) $

Author:

mboyd@sungardsct.com

Field Summary

Fields inherited from class org.jasig.portal.layout.dlm.Evaluator

NAMESPACE_URI, RCS_ID

Constructor Summary

GroupMembershipEvaluator()
Zero-arg constructor required by JPA.

GroupMembershipEvaluator(String mode, String name)

Method Summary

Class<? extends EvaluatorFactory>	getFactoryClass()
boolean	isApplicable(IPerson p)
void	toElement(org.dom4j.Element parent) Serializes this Evaluator into the same XML format supported by dlm.xml.

Methods inherited from class java.lang.Object

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

Constructor Detail

GroupMembershipEvaluator

public GroupMembershipEvaluator()

Zero-arg constructor required by JPA. Other Java code should not use it.

GroupMembershipEvaluator

public GroupMembershipEvaluator(String mode,
                                String name)

Method Detail

isApplicable

public boolean isApplicable(IPerson p)

Specified by:

isApplicable in class Evaluator

toElement

public void toElement(org.dom4j.Element parent)

Description copied from class: Evaluator

Serializes this Evaluator into the same XML format supported by dlm.xml. NOTE: this method will only yield usable XML if invoked on an instance of FragmentDefinition; all other subclasses will return only XML fragments.

Specified by:

toElement in class Evaluator

Parameters:

parent - The XML structure (starting with <dlm:fragment>) so far

getFactoryClass

public Class<? extends EvaluatorFactory> getFactoryClass()

Specified by:

getFactoryClass in class Evaluator