Package org.kuali.rice.kns.datadictionary

Class LookupDefinition

java.lang.Object
org.kuali.rice.krad.datadictionary.DictionaryBeanBase
org.kuali.rice.krad.datadictionary.DataDictionaryDefinitionBase
org.kuali.rice.kns.datadictionary.LookupDefinition
All Implemented Interfaces:
Serializable, Cloneable, Copyable, DataDictionaryDefinition, DictionaryBean
@Deprecated public class LookupDefinition extends DataDictionaryDefinitionBase
Deprecated.
Use LookupView.
Contains lookup-related information relating to the parent BusinessObject.

The lookup element is used to specify the rules for "looking up" a business object. These specifications define the following: How to specify the search criteria used to locate a set of business objects How to display the search results

DD: See LookupDefinition.java

JSTL: The lookup element is a Map which is accessed using a key of "lookup". This map contains the following keys: lookupableID (String, optional) title (String) menubar (String, optional) defaultSort (Map, optional) lookupFields (Map) resultFields (Map) resultSetLimit (String, optional)

See LookupMapBuilder.java

Note: the setters do copious amounts of validation, to facilitate generating errors during the parsing process.
See Also:

  • Field Details

    • lookupableID

      protected String lookupableID
      Deprecated.

    • title

      protected String title
      Deprecated.

    • defaultSort

      protected SortDefinition defaultSort
      Deprecated.

    • lookupFields

      protected List<FieldDefinition> lookupFields
      Deprecated.

    • lookupFieldMap

      protected Map<String,FieldDefinition> lookupFieldMap
      Deprecated.

    • resultFields

      protected List<FieldDefinition> resultFields
      Deprecated.

    • resultFieldMap

      protected Map<String,FieldDefinition> resultFieldMap
      Deprecated.

    • resultSetLimit

      protected Integer resultSetLimit
      Deprecated.

    • multipleValuesResultSetLimit

      protected Integer multipleValuesResultSetLimit
      Deprecated.

    • extraButtonSource

      protected String extraButtonSource
      Deprecated.

    • extraButtonParams

      protected String extraButtonParams
      Deprecated.

    • searchIconOverride

      protected String searchIconOverride
      Deprecated.

    • numOfColumns

      protected int numOfColumns
      Deprecated.

    • helpDefinition

      protected HelpDefinition helpDefinition
      Deprecated.

    • helpUrl

      protected String helpUrl
      Deprecated.

    • translateCodes

      protected boolean translateCodes
      Deprecated.

    • disableSearchButtons

      protected boolean disableSearchButtons
      Deprecated.

  • Constructor Details

    • LookupDefinition

      public LookupDefinition()
      Deprecated.

  • Method Details

    • setLookupableID

      public void setLookupableID(String lookupableID)
      Deprecated.
      The lookupableID element identifies the name of the Spring bean which will be used to obtain the lookupable helper service for the business object. For example, the Balance.xml file has a lookupableId = "glBalanceLookupable". The KualiSpringBeansGL.xml file determines that the helper service will be an instance of BalanceLookupableHelperServiceImpl.
      If this field is omitted, the default bean id used will be kualiLookupable which uses the KualiLookupableHelperServiceImpl helper service.

    • getLookupableID

      public String getLookupableID()
      Deprecated.
      Returns:
      custom lookupable id

    • getTitle

      public String getTitle()
      Deprecated.
      Returns:
      title

    • setTitle

      public void setTitle(String title)
      Deprecated.
      Sets title to the given value.
      Parameters:
      title -
      Throws:
      IllegalArgumentException - if the given title is blank

    • hasMenubar

      public boolean hasMenubar()
      Deprecated.
      Returns:
      true if this instance has a menubar

    • getMenubar

      public String getMenubar()
      Deprecated.
      Returns:
      menubar

    • setMenubar

      public void setMenubar(String menubar)
      Deprecated.
      The menubar element is used to add additional html code to the header line on the lookup screen.
      For example, Account.xml uses this element to add the "create new global" button to the Account Lookup header.
      Throws:
      IllegalArgumentException - if the given menubar is blank

    • hasDefaultSort

      public boolean hasDefaultSort()
      Deprecated.
      Returns:
      true if this instance has a default sort defined

    • getDefaultSort

      public SortDefinition getDefaultSort()
      Deprecated.
      Returns:
      defaultSort

    • setDefaultSort

      public void setDefaultSort(SortDefinition defaultSort)
      Deprecated.
      The defaultSort element specifies the sequence in which the lookup search results should be displayed. It contains an ascending/descending indicator and a list of attribute names.

      DD: See SortDefinition.java

      JSTL: defaultSort is a Map with the following keys: sortAscending (boolean String) sortAttributes (Map)

      By the time JSTL export occurs, the optional attributeName from the defaultSort tag will have been converted into the first contained sortAttribute

      See LookupMapBuilder.java
      Throws:
      IllegalArgumentException - if the given defaultSort is blank

    • getLookupFieldNames

      public List getLookupFieldNames()
      Deprecated.
      Returns:
      List of attributeNames of all lookupField FieldDefinitions associated with this LookupDefinition, in the order in which they were added

    • getLookupFields

      public List<FieldDefinition> getLookupFields()
      Deprecated.
      Returns:
      Collection of all lookupField FieldDefinitions associated with this LookupDefinition, in the order in which they were added

    • getLookupField

      public FieldDefinition getLookupField(String attributeName)
      Deprecated.
      Parameters:
      fieldName -
      Returns:
      FieldDefinition associated with the named lookup field, or null if there is none

    • getResultFieldNames

      public List<String> getResultFieldNames()
      Deprecated.
      Returns:
      List of attributeNames of all resultField FieldDefinitions associated with this LookupDefinition, in the order in which they were added

    • getResultFields

      public List<FieldDefinition> getResultFields()
      Deprecated.
      Returns:
      Collection of all resultField FieldDefinitions associated with this LookupDefinition, in the order in which they were added

    • getResultField

      public FieldDefinition getResultField(String attributeName)
      Deprecated.
      Parameters:
      fieldName -
      Returns:
      FieldDefinition associated with the named result field, or null if there is none

    • setResultSetLimit

      public void setResultSetLimit(Integer resultSetLimit)
      Deprecated.
      The resultSetLimit element specifies the maximum number of records that will be listed as a result of the lookup search.

    • hasResultSetLimit

      public boolean hasResultSetLimit()
      Deprecated.
      Returns:
      true if this instance has a result set limit

    • getResultSetLimit

      public Integer getResultSetLimit()
      Deprecated.
      The resultSetLimit element specifies the maximum number of records that will be listed as a result of the lookup search.

    • setMultipleValuesResultSetLimit

      public void setMultipleValuesResultSetLimit(Integer multipleValuesResultSetLimit)
      Deprecated.
      The multipleValuesResultSetLimit element specifies the maximum number of records that will be listed as a result of a multiple values lookup search.

    • hasMultipleValuesResultSetLimit

      public boolean hasMultipleValuesResultSetLimit()
      Deprecated.
      Returns:
      true if this instance has a multiple values result set limit

    • getMultipleValuesResultSetLimit

      public Integer getMultipleValuesResultSetLimit()
      Deprecated.
      The multipleValuesResultSetLimit element specifies the maximum number of records that will be listed as a result of a multiple values lookup search.

    • completeValidation

      public void completeValidation(Class rootBusinessObjectClass, Class otherBusinessObjectClass)
      Deprecated.
      Directly validate simple fields, call completeValidation on Definition fields.
      Specified by:
      completeValidation in interface DataDictionaryDefinition
      Overrides:
      completeValidation in class DataDictionaryDefinitionBase
      See Also:
      • invalid reference 
        org.kuali.rice.krad.datadictionary.DataDictionaryDefinition#completeValidation(java.lang.Class, java.lang.Object)

    • hasExtraButtonSource

      public boolean hasExtraButtonSource()
      Deprecated.
      Returns:
      true if this instance has extraButtonSource

    • getExtraButtonSource

      public String getExtraButtonSource()
      Deprecated.
      Returns:
      extraButtonSource

    • setExtraButtonSource

      public void setExtraButtonSource(String extraButtonSource)
      Deprecated.
      The extraButton element is used to define additional buttons which will appear on the lookup screen next to the Search and Clear buttons. You can define the image source and additional html parameters for each button.
      The extraButtonSource element defines the location of an image file to use for the extra button.
      Throws:
      IllegalArgumentException - if the given source is blank

    • hasExtraButtonParams

      public boolean hasExtraButtonParams()
      Deprecated.
      Returns:
      true if this instance has extraButtonParams

    • getExtraButtonParams

      public String getExtraButtonParams()
      Deprecated.
      Returns:
      extraButtonParams

    • setExtraButtonParams

      public void setExtraButtonParams(String extraButtonParams)
      Deprecated.
      The extraButton element is used to define additional buttons which will appear on the lookup screen next to the Search and Clear buttons. You can define the image source and additional html parameters for each button.

      The extraButtonParams contains extra HTML parameters that be associated with the button.

    • hasSearchIconOverride

      public boolean hasSearchIconOverride()
      Deprecated.
      Returns:
      true if this instance has an alternate icon to use for lookup icon

    • getSearchIconOverride

      public String getSearchIconOverride()
      Deprecated.
      Returns:
      search icon override url

    • setSearchIconOverride

      public void setSearchIconOverride(String searchIconOverride)
      Deprecated.
      The searchIconOverride element is used to define alternative icons appear on the lookup screen next to the Search and Clear buttons. You can define the image source.
      Throws:
      IllegalArgumentException - if the given source is blank

    • toString

      public String toString()
      Deprecated.
      Overrides:
      toString in class Object

    • setLookupFields

      public void setLookupFields(List<FieldDefinition> lookupFields)
      Deprecated.
      The lookupFields element defines the set of fields in which the user can enter values representing search selection criteria. A search result record will be returned only if the criteria entered in all the lookup fields are met.

      DD: See LookupDefinition.java

      JSTL: lookupFields is a Map which is accessed using a key of "lookupFields". This map contains the following keys: attributeName of first lookup field attributeName of second lookup field etc. The corresponding values are lookupField Export Maps. See LookupMapBuilder.java.

      The lookupField element defines one lookup search criterion field. DD: See LookupDefinition.java.

      JSTL: lookupField is a Map which is accessed by a key which is the attributeName of a lookup field. This map contains entries with the following keys: "attributeName" (String) "required" (boolean String)

      lookupField attribute definitions:

      required = true means that the user must enter something into the search criterion lookup field forceLookup = this attribute is not used noLookup = true means that field should not include magnifying glass (i.e. quickfinder)

    • setResultFields

      public void setResultFields(List<FieldDefinition> resultFields)
      Deprecated.
      The resultFields element specifies the list of fields that are shown as a result of the lookup search.

      JSTL: resultFields is a Map which is accesseed by a key of "resultFields". This map contains entries with the following keys: attributeName of first result field attributeName of second result field etc. The corresponding values are ExportMap's

      The ExportMaps are accessed using a key of attributeName. Each ExportMap contains a single entry as follows: "attributeName" The corresponding value is the attributeName of the field.

      See LookupMapBuilder.java.

    • getNumOfColumns

      public int getNumOfColumns()
      Deprecated.
      Returns:
      the numOfColumns

    • setNumOfColumns

      public void setNumOfColumns(int numOfColumns)
      Deprecated.
      Parameters:
      numOfColumns - the numOfColumns to set

    • getHelpDefinition

      public HelpDefinition getHelpDefinition()
      Deprecated.
      Returns:
      the helpDefinition

    • setHelpDefinition

      public void setHelpDefinition(HelpDefinition helpDefinition)
      Deprecated.
      Parameters:
      helpDefinition - the helpDefinition to set

    • getHelpUrl

      public String getHelpUrl()
      Deprecated.
      Returns:
      the helpUrl

    • setHelpUrl

      public void setHelpUrl(String helpUrl)
      Deprecated.
      Parameters:
      helpUrl - the helpUrl to set

    • isTranslateCodes

      public boolean isTranslateCodes()
      Deprecated.

    • setTranslateCodes

      public void setTranslateCodes(boolean translateCodes)
      Deprecated.

    • isDisableSearchButtons

      public boolean isDisableSearchButtons()
      Deprecated.

    • setDisableSearchButtons

      public void setDisableSearchButtons(boolean disableSearchButtons)
      Deprecated.