org.kuali.student.common.ui.client.util
Class SearchUtils

java.lang.Object
  extended by org.kuali.student.common.ui.client.util.SearchUtils

public class SearchUtils
extends Object

This is a library of utility methods that can be used when working with the search rpc service.


Nested Class Summary
static class SearchUtils.SearchRequestWrapper
          This class wraps the search request, with additional information needed to execute/process a search, such as handling constraints or whether the search should be deferred.
 
Constructor Summary
SearchUtils()
           
 
Method Summary
static SearchRequest initializeSearchRequest(LookupMetadata lookup)
          Use this to build a SearchRequest given a LookupMetadata definition.
static void initializeSearchRequest(LookupMetadata lookup, SearchUtils.SearchRequestWrapper searchRequestWrapper)
          Use this to build a SearchRequest, update search constraints and deferred search options contained within the SearchRequestWrapper.
static String resolvePath(String path)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SearchUtils

public SearchUtils()
Method Detail

initializeSearchRequest

public static SearchRequest initializeSearchRequest(LookupMetadata lookup)
Use this to build a SearchRequest given a LookupMetadata definition. The search request can then be passed into the SearchRpcService to retreive a list of search results.

Parameters:
lookup -
Returns:

initializeSearchRequest

public static void initializeSearchRequest(LookupMetadata lookup,
                                           SearchUtils.SearchRequestWrapper searchRequestWrapper)
Use this to build a SearchRequest, update search constraints and deferred search options contained within the SearchRequestWrapper. The wrapper is mostly to accommodate handling of search options required for constraining values that appear in the KSPicker. Generally this method should not be called directly if only the SearchRequest is required.

Parameters:
lookup -
See Also:
initializeSearchRequest(LookupMetadata)

resolvePath

public static String resolvePath(String path)


Copyright © 2004-2012 The Kuali Foundation. All Rights Reserved.