org.jasig.portal.portlets.lookup
Interface IPersonLookupHelper

All Known Implementing Classes:

PersonLookupHelperImpl

public interface IPersonLookupHelper

Version:

$Revision$

Author:

Eric Dalquist

Field Summary

static String	PERSON_LOOKUP_PERSON_DETAILS_DETAILS_ATTRIBUTES Portlet preference name to use to specify a attributes to display in the user details view
static String	PERSON_LOOKUP_PERSON_DETAILS_DETAILS_ATTRIBUTES_EXCLUDES Portlet preference name to use to specify a attributes to exclude in the user details view
static String	PERSON_LOOKUP_PERSON_LOOKUP_QUERY_ATTRIBUTES Portlet preference name to use to specify a List of attributes displayed in query UI
static String	PERSON_LOOKUP_PERSON_LOOKUP_QUERY_ATTRIBUTES_EXCLUDES Portlet preference name to use to specify a List of attributes displayed in query UI
static String	PERSON_LOOKUP_PERSON_SEARCH_RESULTS_RESULTS_ATTRIBUTES Portlet preference name to use to specify a list of attributes who's values should be passed to the MessageFormat for the resultsMessage string
static String	PERSON_LOOKUP_PERSON_SEARCH_RESULTS_RESULTS_MESSAGE Portlet preference name to use to specify a MessageFormat string for search results list

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
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.

Field Detail

PERSON_LOOKUP_PERSON_LOOKUP_QUERY_ATTRIBUTES

static final String PERSON_LOOKUP_PERSON_LOOKUP_QUERY_ATTRIBUTES

Portlet preference name to use to specify a List of attributes displayed in query UI

See Also:

Constant Field Values

PERSON_LOOKUP_PERSON_LOOKUP_QUERY_ATTRIBUTES_EXCLUDES

static final String PERSON_LOOKUP_PERSON_LOOKUP_QUERY_ATTRIBUTES_EXCLUDES

Portlet preference name to use to specify a List of attributes displayed in query UI

See Also:

Constant Field Values

PERSON_LOOKUP_PERSON_SEARCH_RESULTS_RESULTS_MESSAGE

static final String PERSON_LOOKUP_PERSON_SEARCH_RESULTS_RESULTS_MESSAGE

Portlet preference name to use to specify a MessageFormat string for search results list

See Also:

Constant Field Values

PERSON_LOOKUP_PERSON_SEARCH_RESULTS_RESULTS_ATTRIBUTES

static final String PERSON_LOOKUP_PERSON_SEARCH_RESULTS_RESULTS_ATTRIBUTES

Portlet preference name to use to specify a list of attributes who's values should be passed to the MessageFormat for the resultsMessage string

See Also:

Constant Field Values

PERSON_LOOKUP_PERSON_DETAILS_DETAILS_ATTRIBUTES

static final String PERSON_LOOKUP_PERSON_DETAILS_DETAILS_ATTRIBUTES

Portlet preference name to use to specify a attributes to display in the user details view

See Also:

Constant Field Values

PERSON_LOOKUP_PERSON_DETAILS_DETAILS_ATTRIBUTES_EXCLUDES

static final String PERSON_LOOKUP_PERSON_DETAILS_DETAILS_ATTRIBUTES_EXCLUDES

Portlet preference name to use to specify a attributes to exclude in the user details view

See Also:

Constant Field Values

Method Detail

getQueryAttributes

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

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

Parameters:

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

Returns:

Set of attributes that can be used in a query.

doPersonQuery

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.

Parameters:

query - Query to run for users.

Returns:

Map of users with their name attribute as the key.

getQueryDisplayResults

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.

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

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

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