org.sakaiproject.citation.tool

Class CitationHelperAction.AdvancedSearchHelper

java.lang.Object

org.sakaiproject.citation.tool.CitationHelperAction.AdvancedSearchHelper

Enclosing class:

CitationHelperAction

protected static class CitationHelperAction.AdvancedSearchHelper
extends Object

This class contains constants and utility methods to maintain state of the advanced search form UI and process submitted data

Author:

gbhatnag

Field Summary

Fields

Modifier and Type	Field and Description
static String	AUTHOR_ID
static String	KEYWORD_ID
static String	STATE_CRITERIA1
static String	STATE_CRITERIA2
static String	STATE_CRITERIA3
static String	STATE_CRITERIA4
static String	STATE_CRITERIA5
static String	STATE_FIELD1
static String	STATE_FIELD2
static String	STATE_FIELD3
static String	STATE_FIELD4
static String	STATE_FIELD5
static String	SUBJECT_ID
static String	TITLE_ID
static String	YEAR_ID

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CitationHelperAction.AdvancedSearchHelper()

Method Summary

Methods

Modifier and Type	Method and Description
static void	clearAdvancedFormState(org.sakaiproject.event.api.SessionState state)
static org.sakaiproject.citation.util.api.SearchQuery	getAdvancedCriteria(org.sakaiproject.event.api.SessionState state)
static void	putFieldCriteria(org.sakaiproject.cheftool.Context context, org.sakaiproject.event.api.SessionState state) Puts field criteria stored in session state (using setFieldCriteria()) into the given context
static void	putFieldSelections(org.sakaiproject.cheftool.Context context, org.sakaiproject.event.api.SessionState state) Puts field selections stored in session state (using setFieldSelections()) into the given context
static void	setFieldCriteria(org.sakaiproject.util.ParameterParser params, org.sakaiproject.event.api.SessionState state) Sets user-entered search field criteria in session state from request parameters
static void	setFieldSelections(org.sakaiproject.util.ParameterParser params, org.sakaiproject.event.api.SessionState state) Sets user-selected fields in session state from request parameters

Methods inherited from class java.lang.Object

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

Field Detail

KEYWORD_ID

public static final String KEYWORD_ID

See Also:

Constant Field Values

AUTHOR_ID

public static final String AUTHOR_ID

See Also:

Constant Field Values

TITLE_ID

public static final String TITLE_ID

See Also:

Constant Field Values

SUBJECT_ID

public static final String SUBJECT_ID

See Also:

Constant Field Values

YEAR_ID

public static final String YEAR_ID

See Also:

Constant Field Values

STATE_FIELD1

public static final String STATE_FIELD1

See Also:

Constant Field Values

STATE_FIELD2

public static final String STATE_FIELD2

See Also:

Constant Field Values

STATE_FIELD3

public static final String STATE_FIELD3

See Also:

Constant Field Values

STATE_FIELD4

public static final String STATE_FIELD4

See Also:

Constant Field Values

STATE_FIELD5

public static final String STATE_FIELD5

See Also:

Constant Field Values

STATE_CRITERIA1

public static final String STATE_CRITERIA1

See Also:

Constant Field Values

STATE_CRITERIA2

public static final String STATE_CRITERIA2

See Also:

Constant Field Values

STATE_CRITERIA3

public static final String STATE_CRITERIA3

See Also:

Constant Field Values

STATE_CRITERIA4

public static final String STATE_CRITERIA4

See Also:

Constant Field Values

STATE_CRITERIA5

public static final String STATE_CRITERIA5

See Also:

Constant Field Values

Constructor Detail

CitationHelperAction.AdvancedSearchHelper

protected CitationHelperAction.AdvancedSearchHelper()

Method Detail

putFieldSelections

public static void putFieldSelections(org.sakaiproject.cheftool.Context context,
                      org.sakaiproject.event.api.SessionState state)

Puts field selections stored in session state (using setFieldSelections()) into the given context

Parameters:

context - context to put field selections into

state - SessionState to pull field selections from

putFieldCriteria

public static void putFieldCriteria(org.sakaiproject.cheftool.Context context,
                    org.sakaiproject.event.api.SessionState state)

Puts field criteria stored in session state (using setFieldCriteria()) into the given context

Parameters:

context - context to put field criteria into

state - SessionState to pull field criteria from

setFieldSelections

public static void setFieldSelections(org.sakaiproject.util.ParameterParser params,
                      org.sakaiproject.event.api.SessionState state)

Sets user-selected fields in session state from request parameters

Parameters:

params - request parameters from doBeginSearch

state - SessionState to store field selections

setFieldCriteria

public static void setFieldCriteria(org.sakaiproject.util.ParameterParser params,
                    org.sakaiproject.event.api.SessionState state)

Sets user-entered search field criteria in session state from request parameters

Parameters:

params - request parameters from doBeginSearch

state - SessionState to store field criteria

getAdvancedCriteria

public static org.sakaiproject.citation.util.api.SearchQuery getAdvancedCriteria(org.sakaiproject.event.api.SessionState state)

clearAdvancedFormState

public static void clearAdvancedFormState(org.sakaiproject.event.api.SessionState state)