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

java.lang.Object
  extended by org.kuali.rice.krad.web.form.UifFormBase
      extended by 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, ajaxRequest, ajaxReturnType, attachmentFile, clientStateForSyncing, defaultsApplied, dialogExplanation, dialogResponse, focusId, formHistory, formKey, formPostUrl, growlScript, jumpToId, jumpToName, lightboxScript, methodToCall, newCollectionLines, pageId, postedView, readOnlyFieldsList, renderedInLightBox, renderFullView, requestRedirect, returnFormKey, returnLocation, selectedCollectionLines, skipViewInit, state, updateComponentId, validateDirty, view, viewId, viewName, viewRequestParameters, viewTypeName
 
Constructor Summary
LookupForm()
           
 
Method Summary
 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
 Map<String,String> getLookupCriteria()
           
 Collection<?> getLookupResults()
           
 String getReferencesToRefresh()
           
 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 on the initial request
 void setAtLeastOneRowHasActions(boolean atLeastOneRowHasActions)
           
 void setAtLeastOneRowReturnable(boolean atLeastOneRowReturnable)
           
 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 setLookupCriteria(Map<String,String> lookupCriteria)
           
 void setLookupResults(Collection<?> lookupResults)
           
 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)
           
 
Methods inherited from class org.kuali.rice.krad.web.form.UifFormBase
generateFormKey, getActionEvent, getActionParamaterValue, getActionParameters, getActionParametersAsProperties, getAddedCollectionItems, getAjaxReturnType, getAttachmentFile, getClientStateForSyncing, getDialogExplanation, getDialogManager, getDialogResponse, getFocusId, getFormHistory, getFormKey, getFormPostUrl, getGrowlScript, getJumpToId, getJumpToName, getLightboxScript, getMethodToCall, getNewCollectionLines, getPageId, getPostedView, getReadOnlyFieldsList, getReturnFormKey, getReturnLocation, getSelectedCollectionLines, getState, getUpdateComponentId, getView, getViewId, getViewName, getViewRequestParameters, getViewService, getViewTypeName, isAddedCollectionItem, isAjaxRequest, isDefaultsApplied, isRenderedInLightBox, isRenderFullView, isRequestRedirect, isSkipViewInit, isValidateDirty, setActionParameters, setAddedCollectionItems, setAjaxRequest, setAjaxReturnType, setAttachmentFile, setDefaultsApplied, setDialogExplanation, setDialogManager, setDialogResponse, setFocusId, setFormHistory, setFormKey, setFormPostUrl, setGrowlScript, setJumpToId, setJumpToName, setLightboxScript, setMethodToCall, setNewCollectionLines, setPageId, setPostedView, setReadOnlyFieldsList, setRenderedInLightBox, setRenderFullView, setRequestRedirect, setReturnFormKey, setReturnLocation, setSelectedCollectionLines, setSkipViewInit, setState, setUpdateComponentId, 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 on the initial request

Specified by:
postBind in interface ViewModel
Overrides:
postBind in class UifFormBase
Parameters:
request - - request object containing the query parameters
See Also:
ViewModel.postBind(javax.servlet.http.HttpServletRequest)

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 -

getLookupCriteria

public Map<String,String> getLookupCriteria()

setLookupCriteria

public void setLookupCriteria(Map<String,String> lookupCriteria)

getFieldConversions

public Map<String,String> getFieldConversions()

setFieldConversions

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

getLookupResults

public Collection<?> getLookupResults()

setLookupResults

public void setLookupResults(Collection<?> lookupResults)

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 -


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