Package org.kuali.rice.kns.datadictionary

Class InquirySectionDefinition

java.lang.Object
org.kuali.rice.krad.datadictionary.DictionaryBeanBase
org.kuali.rice.krad.datadictionary.DataDictionaryDefinitionBase
org.kuali.rice.kns.datadictionary.InquirySectionDefinition
All Implemented Interfaces:
Serializable, Cloneable, Copyable, DataDictionaryDefinition, DictionaryBean
@Deprecated public class InquirySectionDefinition extends DataDictionaryDefinitionBase
Deprecated.
Use sections inside of InquiryView.
inquirySection defines the format and content of one section of the inquiry. DD: See InquirySectionDefinition.java numberOfColumns = the number of fields to be displayed in each row of the inquiry section. For example, numberOfColumns = 2 indicates that the label and values for two fields will be displayed in each row as follows: field1label field1value | field2label field2value field3label field3value | field4label field4value etc. Contains section-related information for inquiry sections Note: the setters do copious amounts of validation, to facilitate generating errors during the parsing process.
See Also:

  • Field Details

    • title

      protected String title
      Deprecated.

    • inquiryFields

      protected List<FieldDefinition> inquiryFields
      Deprecated.

    • inquiryFieldMap

      protected Map<String,FieldDefinition> inquiryFieldMap
      Deprecated.

    • inquiryCollections

      protected Map inquiryCollections
      Deprecated.

    • numberOfColumns

      protected Integer numberOfColumns
      Deprecated.

    • defaultOpen

      protected boolean defaultOpen
      Deprecated.

  • Constructor Details

    • InquirySectionDefinition

      public InquirySectionDefinition()
      Deprecated.

  • Method Details

    • 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

    • getInquiryFieldNames

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

    • getInquiryFields

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

    • 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)

    • toString

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

    • getInquiryCollections

      public Map getInquiryCollections()
      Deprecated.

    • setInquiryCollections

      public void setInquiryCollections(Map inquiryCollections)
      Deprecated.
      The inquiryCollection defines a collection within the Business Object which contains data that should be displayed with the BO when the inquiry is performed. Each inquiryCollection defines a set of data fields, nested inquiryCollections and summaryFields. The summaryFields will be reported in the header of this inquiryCollection, . DD: See InquiryCollectionDefinition.java JSTL: The inquiryCollection element is a Map with the following keys: name (String) dataObjectClass (String) numberOfColumns (String) inquiryFields (Map) inquiryCollections (Map, optional) summaryTitle (String) summaryFields (Map, optional)

    • getNumberOfColumns

      public Integer getNumberOfColumns()
      Deprecated.

    • setNumberOfColumns

      public void setNumberOfColumns(Integer numberOfColumns)
      Deprecated.
      numberOfColumns = the number of fields to be displayed in each row of the inquiry section. For example, numberOfColumns = 2 indicates that the label and values for two fields will be displayed in each row as follows: field1label field1value | field2label field2value field3label field3value | field4label field4value etc.

    • setInquiryFields

      public void setInquiryFields(List<FieldDefinition> inquiryFields)
      Deprecated.
      JSTL: inquiryFields is a Map which is accessed using a key of "inquiryFields". This map contains the following types of elements: inquirySubSectionHeader field inquiryCollection Each of these entries are keyed by "attributeName". The associated value is the attributeName of the mapped element. The inquirySubSectionHeader allows a separator containing text to separate groups of fields. The name attribute is the displayed text. JSTL: inquirySubSectionHeader appears in the inquiryFields map as: key = "attributeName" value = name of inquirySubSectionHeader The field element defines the attributes of a single data field. DD: See FieldDefinition.java JSTL: The field element is a Map which is accessed using a key of the attributeName. This map contains the following keys: attributeName (String) forceInquiry (boolean String) noInquiry (boolean String) maxLength (String) forceInquiry = true means that the displayed field value will always be made inquirable (this attribute is not used within the code). noInquiry = true means that the displayed field will never be made inquirable. maxLength = the maximum allowable length of the field in the lookup result fields. In other contexts, like inquiries, this field has no effect.

    • isDefaultOpen

      public boolean isDefaultOpen()
      Deprecated.
      Returns:
      the defaultOpen

    • setDefaultOpen

      public void setDefaultOpen(boolean defaultOpen)
      Deprecated.
      Parameters:
      defaultOpen - the defaultOpen to set