org.jasig.portal.portlets.lookup
Class PersonLookupHelperImpl

java.lang.Object
  org.jasig.portal.portlets.lookup.PersonLookupHelperImpl

All Implemented Interfaces:

IPersonLookupHelper

public class PersonLookupHelperImpl
extends Object
implements IPersonLookupHelper

Implements logic and helper methods for the person-lookup web flow.

Version:

$Revision$

Author:

Eric Dalquist

Field Summary

protected org.apache.commons.logging.Log

logger

Fields inherited from interface org.jasig.portal.portlets.lookup.IPersonLookupHelper

PERSON_LOOKUP_PERSON_DETAILS_DETAILS_ATTRIBUTES, PERSON_LOOKUP_PERSON_DETAILS_DETAILS_ATTRIBUTES_EXCLUDES, PERSON_LOOKUP_PERSON_LOOKUP_QUERY_ATTRIBUTES, PERSON_LOOKUP_PERSON_LOOKUP_QUERY_ATTRIBUTES_EXCLUDES, PERSON_LOOKUP_PERSON_SEARCH_RESULTS_RESULTS_ATTRIBUTES, PERSON_LOOKUP_PERSON_SEARCH_RESULTS_RESULTS_MESSAGE

Constructor Summary

PersonLookupHelperImpl()

Method Summary

Map<String,org.jasig.services.persondir.IPersonAttributes>	doPersonQuery(org.springframework.webflow.context.ExternalContext externalContext, PersonQuery query) Execute a query for users using the attributes in the passed PersonQuery object.
Set<String>	getDisplayAttributes(org.springframework.webflow.context.ExternalContext externalContext, org.jasig.services.persondir.IPersonAttributes person) Gets the Set of attributes to display in the user details view
org.jasig.services.persondir.IPersonAttributeDao	getPersonAttributeDao()
Set<String>	getQueryAttributes(org.springframework.webflow.context.ExternalContext externalContext) Gets the Set of attributes to allow the user to query with.
Map<org.jasig.services.persondir.IPersonAttributes,String>	getQueryDisplayResults(org.springframework.webflow.context.ExternalContext externalContext, Collection<org.jasig.services.persondir.IPersonAttributes> queryResults) Performs formatting of strings to display on the query results view.
void	setPersonAttributeDao(org.jasig.services.persondir.IPersonAttributeDao personLookupDao) The IPersonAttributeDao used to perform lookups.

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final org.apache.commons.logging.Log logger

Constructor Detail

PersonLookupHelperImpl

public PersonLookupHelperImpl()

Method Detail

getPersonAttributeDao

public org.jasig.services.persondir.IPersonAttributeDao getPersonAttributeDao()

setPersonAttributeDao

public void setPersonAttributeDao(org.jasig.services.persondir.IPersonAttributeDao personLookupDao)

The IPersonAttributeDao used to perform lookups.

getQueryAttributes

public Set<String> getQueryAttributes(org.springframework.webflow.context.ExternalContext externalContext)

Description copied from interface: IPersonLookupHelper

Gets the Set of attributes to allow the user to query with.

Specified by:

getQueryAttributes in interface IPersonLookupHelper

Parameters:

externalContext - The ExternalContext to get the flows's configuration from

Returns:

Set of attributes that can be used in a query.

doPersonQuery

public Map<String,org.jasig.services.persondir.IPersonAttributes> doPersonQuery(org.springframework.webflow.context.ExternalContext externalContext,
                                                                                PersonQuery query)

Description copied from interface: IPersonLookupHelper

Execute a query for users using the attributes in the passed PersonQuery object.

Specified by:

doPersonQuery in interface IPersonLookupHelper

query - Query to run for users.

Returns:

Map of users with their name attribute as the key.

getQueryDisplayResults

public Map<org.jasig.services.persondir.IPersonAttributes,String> getQueryDisplayResults(org.springframework.webflow.context.ExternalContext externalContext,
                                                                                         Collection<org.jasig.services.persondir.IPersonAttributes> queryResults)

Description copied from interface: IPersonLookupHelper

Performs formatting of strings to display on the query results view.

Specified by:

getQueryDisplayResults in interface IPersonLookupHelper

Parameters:

externalContext - The ExternalContext to get the flows's configuration from

queryResults - Results of the query

Returns:

Formatted strings as values and user names as keys.

getDisplayAttributes

public Set<String> getDisplayAttributes(org.springframework.webflow.context.ExternalContext externalContext,
                                        org.jasig.services.persondir.IPersonAttributes person)

Description copied from interface: IPersonLookupHelper

Gets the Set of attributes to display in the user details view

Specified by:

getDisplayAttributes in interface IPersonLookupHelper

Parameters:

externalContext - The ExternalContext to get the flows's configuration from

person - The person who's attributes will be displayed

Returns:

Set of attributes to display