| org.kuali.core.lookup.Lookupable
All known Subclasses: org.kuali.core.lookup.KualiLookupableImpl,
| Lookupable | | public interface Lookupable extends Serializable(Code) | | This class defines an interface for lookupables.
They should act as facades for LookupableHelperServices and also expose bean handlers
(getCreateNewUrl, getHtmlMenuBar, getTitle, getRows, getExtraButton{Source,Params}, getLookupInstructions)
|
| checkForAdditionalFields | | public boolean checkForAdditionalFields(Map fieldValues)(Code) | | Determines if there should be more search fields rendered based on already entered search criteria.
Parameters:
fieldValues - - Map of property/value pairs boolean |
| getBusinessObjectClass | | public Class getBusinessObjectClass()(Code) | | Returns the businessObjectClass this lookupable is representing |
| getColumns | | public List getColumns()(Code) | | List of Column objects used to render the result table |
| getCreateNewUrl | | public String getCreateNewUrl()(Code) | | Builds the Url for a maintenance new document for the lookup business object class
Parameters:
businessObject - String rendered on Lookup screen for maintenance new document |
| getDefaultSortColumns | | public List getDefaultSortColumns()(Code) | | This method returns a list of the default columns used to sort the result set. For multiple value lookups,
this method does not change when different columns are sorted.
|
| getExtraButtonParams | | public String getExtraButtonParams()(Code) | | String providing return parameters for optional extra button |
| getExtraButtonSource | | public String getExtraButtonSource()(Code) | | String providing source for optional extra button |
| getHtmlMenuBar | | public String getHtmlMenuBar()(Code) | | the html to be displayed as a menu bar |
| getLookupInstructions | | public String getLookupInstructions()(Code) | | String providing instructions for using the lookup |
| getLookupableHelperService | | public LookupableHelperService getLookupableHelperService()(Code) | | Returns the LookupableHelperService designated to help this lookup
|
| getPrimaryKeyFieldLabels | | public String getPrimaryKeyFieldLabels()(Code) | | Returns a comma delimited list of primary key field labels, as defined in the DD
|
| getReturnLocation | | public String getReturnLocation()(Code) | | String url for the location to return to after the lookup |
| getReturnUrl | | public String getReturnUrl(BusinessObject businessObject, Map fieldConversions, String lookupImpl)(Code) | | Builds the return value url.
Parameters:
businessObject - - Instance of a business object containing the return values
Parameters:
fieldConversions - - Map of conversions mapping bo names to caller field names.
Parameters:
lookupImpl - - Current lookup impl name String url called when selecting a row from the result set |
| getRows | | public List getRows()(Code) | | List of Row objects used to render the search area |
| getSearchResults | | public List<BusinessObject> getSearchResults(Map<String, String> fieldValues)(Code) | | Performs a search and returns result list.
Parameters:
fieldValues - - Map of property/value pairs List of business objects found by the search
throws:
Exception - |
| getSearchResultsUnbounded | | public List<BusinessObject> getSearchResultsUnbounded(Map<String, String> fieldValues)(Code) | | Similar to getSearchResults, but the number of returned rows is not bounded
Parameters:
fieldValues - |
| getTitle | | public String getTitle()(Code) | | String displayed as title for the lookup |
| isSearchUsingOnlyPrimaryKeyValues | | public boolean isSearchUsingOnlyPrimaryKeyValues()(Code) | | Returns whether this search was performed using the values of the primary keys only
|
| performLookup | | public Collection performLookup(LookupForm lookupForm, List<ResultRow> resultTable, boolean bounded)(Code) | | This method performs the lookup and returns a collection of lookup items
Parameters:
lookupForm -
Parameters:
resultTable -
Parameters:
bounded - results of lookup |
| setBusinessObjectClass | | public void setBusinessObjectClass(Class businessObjectClass)(Code) | | Initializes the lookup with a businss object class
It is required that implementations of this method will initialize the
search area used by the UI to provide the search form. In particular,
it will ensure that getRows() will return valid results
Parameters:
boClass - |
| setFieldConversions | | public void setFieldConversions(Map fieldConversions)(Code) | | Sets the requested fields conversions in the lookupable
Parameters:
fieldConversions - |
| setLookupableHelperService | | public void setLookupableHelperService(LookupableHelperService helper)(Code) | | Sets the helper service for instance
Parameters:
helper - the helper service |
| setReadOnlyFieldsList | | public void setReadOnlyFieldsList(List<String> readOnlyFieldsList)(Code) | | Sets the requested read only fields list in the lookupable
Parameters:
readOnlyFieldsList - |
| validateSearchParameters | | public void validateSearchParameters(Map fieldValues)(Code) | | Validates the values filled in as search criteria, also checks for required field values.
Parameters:
fieldValues - - Map of property/value pairs |
|
|