org.kuali.rice.krad.web.form

Class LookupForm

java.lang.Object

org.kuali.rice.krad.web.form.UifFormBase

org.kuali.rice.krad.web.form.LookupForm

All Implemented Interfaces:

Serializable, ViewModel

public class LookupForm
extends UifFormBase

Form class for LookupView screens

Author:

Kuali Rice Team (rice.collab@kuali.org)

See Also:

Serialized Form

Field Summary

Fields inherited from class org.kuali.rice.krad.web.form.UifFormBase

actionParameters, attachmentFile, clientStateForSyncing, defaultsApplied, focusId, formHistory, formKey, formPostUrl, jumpToId, jumpToName, methodToCall, newCollectionLines, pageId, postedView, readOnlyFieldsList, renderFullView, returnFormKey, returnLocation, selectedCollectionLines, skipViewInit, validateDirty, view, viewId, viewName, viewRequestParameters, viewTypeName

Constructor Summary

Constructors

Constructor and Description
LookupForm()

Method Summary

Modifier and Type	Method and Description
Map<String,String>	getCriteriaFields()
String	getDataObjectClassName()
String	getDocNum()
Map<String,String>	getFieldConversions()
Lookupable	getLookupable()
String	getLookupCollectionName() For the case of multi-value lookup, indicates the collection that should be populated with the return results
String	getReferencesToRefresh()
Collection<?>	getSearchResults()
boolean	isAtLeastOneRowHasActions()
boolean	isAtLeastOneRowReturnable()
boolean	isMultipleValuesSelect() Indicates whether multiple values select should be enabled for the lookup
boolean	isRedirectedLookup() Indicates whether the requested was redirected from the lookup framework due to an external object request.
void	postBind(javax.servlet.http.HttpServletRequest request) Picks out business object name from the request to get retrieve a lookupable and set properties
void	setAtLeastOneRowHasActions(boolean atLeastOneRowHasActions)
void	setAtLeastOneRowReturnable(boolean atLeastOneRowReturnable)
void	setCriteriaFields(Map<String,String> criteriaFields)
void	setDataObjectClassName(String dataObjectClassName)
void	setDocNum(String docNum)
void	setFieldConversions(Map<String,String> fieldConversions)
void	setLookupCollectionName(String lookupCollectionName) Setter for the name of the collection that should be populated with lookup results
void	setMultipleValuesSelect(boolean multipleValuesSelect) Setter for the multiple values select indicator
void	setRedirectedLookup(boolean redirectedLookup) Setter for the redirected request indicator
void	setReferencesToRefresh(String referencesToRefresh)
void	setSearchResults(Collection<?> searchResults)

Methods inherited from class org.kuali.rice.krad.web.form.UifFormBase

generateFormKey, getActionEvent, getActionParamaterValue, getActionParameters, getActionParametersAsProperties, getAttachmentFile, getClientStateForSyncing, getFocusId, getFormHistory, getFormKey, getFormPostUrl, getJumpToId, getJumpToName, getMethodToCall, getNewCollectionLines, getPageId, getPostedView, getReadOnlyFieldsList, getReturnFormKey, getReturnLocation, getSelectedCollectionLines, getView, getViewId, getViewName, getViewRequestParameters, getViewService, getViewTypeName, isDefaultsApplied, isRenderFullView, isSkipViewInit, isValidateDirty, setActionParameters, setAttachmentFile, setDefaultsApplied, setFocusId, setFormHistory, setFormKey, setFormPostUrl, setJumpToId, setJumpToName, setMethodToCall, setNewCollectionLines, setPageId, setPostedView, setReadOnlyFieldsList, setRenderFullView, setReturnFormKey, setReturnLocation, setSelectedCollectionLines, setSkipViewInit, setValidateDirty, setView, setViewId, setViewName, setViewRequestParameters, setViewTypeName

Methods inherited from class java.lang.Object

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

Constructor Detail

LookupForm

public LookupForm()

Method Detail

postBind

public void postBind(javax.servlet.http.HttpServletRequest request)

Picks out business object name from the request to get retrieve a lookupable and set properties

Overrides:

postBind in class UifFormBase

Parameters:

request - - request object containing the query parameters

getLookupable

public Lookupable getLookupable()

getDataObjectClassName

public String getDataObjectClassName()

setDataObjectClassName

public void setDataObjectClassName(String dataObjectClassName)

getDocNum

public String getDocNum()

setDocNum

public void setDocNum(String docNum)

getReferencesToRefresh

public String getReferencesToRefresh()

setReferencesToRefresh

public void setReferencesToRefresh(String referencesToRefresh)

isMultipleValuesSelect

public boolean isMultipleValuesSelect()

Indicates whether multiple values select should be enabled for the lookup

When set to true, the select field is enabled for the lookup results group that allows the user to select one or more rows for returning

Returns:

boolean true if multiple values should be enabled, false otherwise

setMultipleValuesSelect

public void setMultipleValuesSelect(boolean multipleValuesSelect)

Setter for the multiple values select indicator

Parameters:

multipleValuesSelect -

getLookupCollectionName

public String getLookupCollectionName()

For the case of multi-value lookup, indicates the collection that should be populated with the return results

Returns:

String collection name (must be full binding path)

setLookupCollectionName

public void setLookupCollectionName(String lookupCollectionName)

Setter for the name of the collection that should be populated with lookup results

Parameters:

lookupCollectionName -

getCriteriaFields

public Map<String,String> getCriteriaFields()

setCriteriaFields

public void setCriteriaFields(Map<String,String> criteriaFields)

getFieldConversions

public Map<String,String> getFieldConversions()

setFieldConversions

public void setFieldConversions(Map<String,String> fieldConversions)

getSearchResults

public Collection<?> getSearchResults()

setSearchResults

public void setSearchResults(Collection<?> searchResults)

isAtLeastOneRowReturnable

public boolean isAtLeastOneRowReturnable()

setAtLeastOneRowReturnable

public void setAtLeastOneRowReturnable(boolean atLeastOneRowReturnable)

isAtLeastOneRowHasActions

public boolean isAtLeastOneRowHasActions()

setAtLeastOneRowHasActions

public void setAtLeastOneRowHasActions(boolean atLeastOneRowHasActions)

isRedirectedLookup

public boolean isRedirectedLookup()

Indicates whether the requested was redirected from the lookup framework due to an external object request. This prevents the framework from performing another redirect check

Returns:

boolean true if request was a redirect, false if not

setRedirectedLookup

public void setRedirectedLookup(boolean redirectedLookup)

Setter for the redirected request indicator

Parameters:

redirectedLookup -