edu.internet2.middleware.grouper.grouperUi.beans.dojo

Interface DojoComboQueryLogic<T>

All Known Implementing Classes:

DojoComboQueryLogicBase

public interface DojoComboQueryLogic<T>

Logic you implement for a query from a combobox The template is the return type for the queries

Method Summary

Modifier and Type	Method and Description
String	initialValidationError(javax.servlet.http.HttpServletRequest request, GrouperSession grouperSession) return a string if there is some sort of validation error at the beginning
T	lookup(javax.servlet.http.HttpServletRequest request, GrouperSession grouperSession, String query) lookup one object (could be by name or id).
String	retrieveHtmlLabel(GrouperSession grouperSession, T t) get the html label (if applicable) for the object for the json.
String	retrieveId(GrouperSession grouperSession, T t) get the id of the object for the json, do not escape HTML
String	retrieveLabel(GrouperSession grouperSession, T t) get the label of the object for the json, do not escape HTML
Collection<T>	search(javax.servlet.http.HttpServletRequest request, GrouperSession grouperSession, String query) get a paged list of return objects by the query.
boolean	validQueryOverride(GrouperSession grouperSession, String query) return true if this is a valid query, or false for the default behavior

Method Detail

validQueryOverride

boolean validQueryOverride(GrouperSession grouperSession,
                           String query)

return true if this is a valid query, or false for the default behavior

Parameters:

grouperSession -

query -

lookup

T lookup(javax.servlet.http.HttpServletRequest request,
         GrouperSession grouperSession,
         String query)

lookup one object (could be by name or id). Note, this should do the security too

Parameters:

query -

request -

grouperSession -

Returns:

the object or null if not found.

search

Collection<T> search(javax.servlet.http.HttpServletRequest request,
                     GrouperSession grouperSession,
                     String query)

get a paged list of return objects by the query. Note, this should do the security too

Parameters:

query -

request -

grouperSession -

Returns:

the objects or null if not found

retrieveId

String retrieveId(GrouperSession grouperSession,
                  T t)

get the id of the object for the json, do not escape HTML

Parameters:

t -

Returns:

the id

retrieveLabel

String retrieveLabel(GrouperSession grouperSession,
                     T t)

get the label of the object for the json, do not escape HTML

Parameters:

t -

Returns:

the id

retrieveHtmlLabel

String retrieveHtmlLabel(GrouperSession grouperSession,
                         T t)

get the html label (if applicable) for the object for the json. if null, then it will just use the label

Parameters:

grouperSession -

t -

Returns:

the label

initialValidationError

String initialValidationError(javax.servlet.http.HttpServletRequest request,
                              GrouperSession grouperSession)

return a string if there is some sort of validation error at the beginning

Parameters:

request -

groupperSession -

Returns:

an error message or null if none