org.apereo.services.persondir.support.rule

Interface AttributeRule

All Known Implementing Classes:

SimpleAttributeRule, StringFormatAttributeRule

public interface AttributeRule

Defines the contract for a person directory user attribute rule for use with the DeclaredRulePersonAttributeDao.

Method Summary

Modifier and Type	Method and Description
boolean	appliesTo(java.util.Map<java.lang.String,java.util.List<java.lang.Object>> userInfo) Indicates whether the rule applies to the user described by the specified information.
java.util.Set<IPersonAttributes>	evaluate(java.util.Map<java.lang.String,java.util.List<java.lang.Object>> userInfo) Applies the embodied rule to the user described by the specified information and returns the result.
java.util.Set<java.lang.String>	getAvailableQueryAttributes()
java.util.Set<java.lang.String>	getPossibleUserAttributeNames() Indicates the complete set of user attribute names that may be returned by a call to evaluate.

Method Detail

appliesTo

boolean appliesTo(java.util.Map<java.lang.String,java.util.List<java.lang.Object>> userInfo)

Indicates whether the rule applies to the user described by the specified information. Implementations of AttributeRule must not change the input Map. Implementations dictate the expected types for the Keys and Values of the Map.

Parameters:

userInfo - immutable Map of attributes to values for the implementation to determine if this rule applies, must not be null.

Returns:

TRUE if this rule applies to the Map data, FALSE if not.

Throws:

java.lang.IllegalArgumentException - If userInfo is null.

evaluate

java.util.Set<IPersonAttributes> evaluate(java.util.Map<java.lang.String,java.util.List<java.lang.Object>> userInfo)

Applies the embodied rule to the user described by the specified information and returns the result. This method follows the same contract as IPersonAttributeDao.getPeopleWithMultivaluedAttributes(Map)

Parameters:

userInfo - User info

Returns:

Set of IPersonAttributes

getPossibleUserAttributeNames

java.util.Set<java.lang.String> getPossibleUserAttributeNames()

Indicates the complete set of user attribute names that may be returned by a call to evaluate. This method follows the same contract as IPersonAttributeDao.getPossibleUserAttributeNames()

Returns:

Complete set of possible user attribute names that may be returned by a call to evaluate.

getAvailableQueryAttributes

java.util.Set<java.lang.String> getAvailableQueryAttributes()

Returns:

Complete set of actual user attribute names that may be returned by a call to evaluate.

See Also:

IPersonAttributeDao.getAvailableQueryAttributes()