Package org.kuali.rice.kns.service

Interface BusinessObjectDictionaryService

@Deprecated public interface BusinessObjectDictionaryService
Deprecated.
Only used in KNS classes, use KRAD.
This interface defines the API for the interacting with the data dictionary.

  • Method Details

    • getInquiryPresentationController

      <T extends BusinessObject> InquiryPresentationController getInquiryPresentationController(Class<T> businessObjectClass)
      Deprecated.

    • getInquiryAuthorizer

      <T extends BusinessObject> InquiryAuthorizer getInquiryAuthorizer(Class<T> businessObjectClass)
      Deprecated.

    • getBusinessObjectClassnames

      List getBusinessObjectClassnames()
      Deprecated.
      the list of business object class names being maintained

    • isLookupable

      Boolean isLookupable(Class businessObjectClass)
      Deprecated.
      indicates whether business object has lookup defined

    • isInquirable

      Boolean isInquirable(Class businessObjectClass)
      Deprecated.
      indicates whether business object has inquiry defined

    • isMaintainable

      Boolean isMaintainable(Class businessObjectClass)
      Deprecated.
      indicates whether business object has maintainable defined

    • isExportable

      Boolean isExportable(Class businessObjectClass)
      Deprecated.
      indicates whether business object has an exporter defined

    • getLookupFieldNames

      List getLookupFieldNames(Class businessObjectClass)
      Deprecated.
      the list defined as lookup fields for the business object.

    • getLookupTitle

      String getLookupTitle(Class businessObjectClass)
      Deprecated.
      the text to be displayed for the title of business object lookup.

    • getLookupMenuBar

      String getLookupMenuBar(Class businessObjectClass)
      Deprecated.
      menu bar html defined for the business object.

    • getExtraButtonSource

      String getExtraButtonSource(Class businessObjectClass)
      Deprecated.
      source for optional extra button

    • getExtraButtonParams

      String getExtraButtonParams(Class businessObjectClass)
      Deprecated.
      return parameters for optional extra button

    • getLookupDefaultSortFieldNames

      List getLookupDefaultSortFieldNames(Class businessObjectClass)
      Deprecated.
      the property names of the bo used to sort the initial result set

    • getLookupResultFieldNames

      List<String> getLookupResultFieldNames(Class businessObjectClass)
      Deprecated.
      the list defined as lookup result fields for the business object.

    • getLookupResultFieldMaxLength

      Integer getLookupResultFieldMaxLength(Class businessObjectClass, String resultFieldName)
      Deprecated.
      This method returns the maximum display length of the value of the given field in the lookup results. While the actual value may be longer than the specified length, this value specifies the maximum length substring that should be displayed. It is up to the UI layer to intepret the results of the field
      Parameters:
      businessObjectClass -
      resultFieldName -
      Returns:
      the maximum length of the lookup results field that should be displayed. Returns null if this value has not been defined. If negative, denotes that the is maximum length is unlimited.

    • forceLookupResultFieldInquiry

      Boolean forceLookupResultFieldInquiry(Class businessObjectClass, String attributeName)
      Deprecated.
      returns boolean indicating whether lookup result field marked to force an inquiry

    • noLookupResultFieldInquiry

      Boolean noLookupResultFieldInquiry(Class businessObjectClass, String attributeName)
      Deprecated.
      returns boolean indicating whether lookup result field marked to not do an inquiry

    • forceLookupFieldLookup

      Boolean forceLookupFieldLookup(Class businessObjectClass, String attributeName)
      Deprecated.
      returns boolean indicating whether lookup search field marked to force a lookup

    • forceInquiryFieldLookup

      Boolean forceInquiryFieldLookup(Class businessObjectClass, String attributeName)
      Deprecated.
      returns boolean indicating whether lookup search field marked to force an inquiry

    • noLookupFieldLookup

      Boolean noLookupFieldLookup(Class businessObjectClass, String attributeName)
      Deprecated.
      returns boolean indicating whether lookup search field marked to not do a lookup

    • noDirectInquiryFieldLookup

      Boolean noDirectInquiryFieldLookup(Class businessObjectClass, String attributeName)
      Deprecated.
      returns boolean indicating whether lookup search field marked to not do a direct inquiry

    • forceInquiryFieldInquiry

      Boolean forceInquiryFieldInquiry(Class businessObjectClass, String attributeName)
      Deprecated.
      returns boolean indicating whether inquiry result field marked to force an inquiry

    • noInquiryFieldInquiry

      Boolean noInquiryFieldInquiry(Class businessObjectClass, String attributeName)
      Deprecated.
      returns boolean indicating whether inquiry result field marked to not do an inquiry

    • getLookupResultFieldUseShortLabel

      Boolean getLookupResultFieldUseShortLabel(Class businessObjectClass, String attributeName)
      Deprecated.
      returns boolean indicating whether lookup result field to use shortLabel

    • getLookupResultFieldTotal

      Boolean getLookupResultFieldTotal(Class businessObjectClass, String attributeName)
      Deprecated.
      returns boolean indicating whether lookup result field should be totaled

    • getLookupFieldDefaultValue

      String getLookupFieldDefaultValue(Class businessObjectClass, String attributeName)
      Deprecated.
      returns String indicating the default search value for the lookup field

    • getLookupFieldDefaultValueFinderClass

      Class getLookupFieldDefaultValueFinderClass(Class businessObjectClass, String attributeName)
      Deprecated.
      returns Class used to generate a lookup field default value

    • getLookupFieldQuickfinderParameterString

      String getLookupFieldQuickfinderParameterString(Class businessObjectClass, String attributeName)
      Deprecated.
      See
      invalid reference 
      FieldDefinition#getQuickfinderParameterString()
      . returns String indicating the default search value for the lookup field.

    • getLookupFieldQuickfinderParameterStringBuilderClass

      Class<? extends ValueFinder> getLookupFieldQuickfinderParameterStringBuilderClass(Class businessObjectClass, String attributeName)
      Deprecated.
      returns Class used to generate quickfinder lookup field default values. See
      invalid reference 
      FieldDefinition#getQuickfinderParameterStringBuilderClass()
      .

    • getLookupResultSetLimit

      Integer getLookupResultSetLimit(Class businessObjectClass)
      Deprecated.
      returns String indicating the result set limit for the lookup

    • getMultipleValueLookupResultSetLimit

      Integer getMultipleValueLookupResultSetLimit(Class businessObjectClass)
      Deprecated.
      returns Integer indicating the result set limit for a multiple values lookup

    • getLookupNumberOfColumns

      Integer getLookupNumberOfColumns(Class businessObjectClass)
      Deprecated.
      Returns:
      number of search columns configured for the lookup associated with the class

    • getSearchIconOverride

      String getSearchIconOverride(Class businessObjectClass)
      Deprecated.
      returns String indicating the location of the lookup icon.

    • getLookupAttributeRequired

      Boolean getLookupAttributeRequired(Class businessObjectClass, String attributeName)
      Deprecated.
      indicates whether a field is required for a lookup

    • getLookupAttributeReadOnly

      Boolean getLookupAttributeReadOnly(Class businessObjectClass, String attributeName)
      Deprecated.
      indicates whether a field is read only for a lookup

    • getInquiryFieldNames

      List getInquiryFieldNames(Class businessObjectClass, String sectionTitle)
      Deprecated.
      the list defined as inquiry fields for the business object and inquiry section.

    • getInquirySections

      List getInquirySections(Class businessObjectClass)
      Deprecated.
      the list defined as inquiry sections for the business object.

    • getInquiryTitle

      String getInquiryTitle(Class businessObjectClass)
      Deprecated.
      the text to be displayed for the title of business object inquiry.

    • getInquirableClass

      Class getInquirableClass(Class businessObjectClass)
      Deprecated.
      the class to be used for building inquiry pages.

    • getMaintainableLabel

      String getMaintainableLabel(Class businessObjectClass)
      Deprecated.
      the text to be displayed for the title of business object maintenance document.

    • getTitleAttribute

      String getTitleAttribute(Class businessObjectClass)
      Deprecated.
      the attribute to be associated with for object level markings

    • getLookupableID

      String getLookupableID(Class businessObjectClass)
      Deprecated.
      the Lookupable implementation id for the associated Lookup, if one has been specified

    • performForceUppercase

      void performForceUppercase(BusinessObject bo)
      Deprecated.
      This method takes any business object and recursively walks through it checking to see if any attributes need to be forced to uppercase based on settings in the data dictionary
      Parameters:
      bo -

    • isLookupFieldTreatWildcardsAndOperatorsAsLiteral

      boolean isLookupFieldTreatWildcardsAndOperatorsAsLiteral(Class businessObjectClass, String attributeName)
      Deprecated.
      returns whether on a lookup, field/attribute values with wildcards and operators should treat them as literal characters
      Parameters:
      businessObjectClass -
      attributeName -
      Returns:

    • getLookupFieldAlternateDisplayAttributeName

      String getLookupFieldAlternateDisplayAttributeName(Class businessObjectClass, String attributeName)
      Deprecated.
      returns String giving alternate display attribute name for lookup field if configured, or null

    • getInquiryFieldAlternateDisplayAttributeName

      String getInquiryFieldAlternateDisplayAttributeName(Class businessObjectClass, String attributeName)
      Deprecated.
      returns String giving alternate display attribute name for inquiry field if configured, or null

    • getLookupFieldAdditionalDisplayAttributeName

      String getLookupFieldAdditionalDisplayAttributeName(Class businessObjectClass, String attributeName)
      Deprecated.
      returns String giving additional display attribute name for lookup field if configured, or null

    • getInquiryFieldAdditionalDisplayAttributeName

      String getInquiryFieldAdditionalDisplayAttributeName(Class businessObjectClass, String attributeName)
      Deprecated.
      returns String giving additional display attribute name for inquiry field if configured, or null

    • tranlateCodesInLookup

      Boolean tranlateCodesInLookup(Class businessObjectClass)
      Deprecated.
      Parameters:
      businessObjectClass - - business object class for lookup definition
      Returns:
      Boolean indicating whether translating of codes is configured to true in lookup definition

    • tranlateCodesInInquiry

      Boolean tranlateCodesInInquiry(Class businessObjectClass)
      Deprecated.
      Parameters:
      businessObjectClass - - business object class for inquiry definition
      Returns:
      Boolean indicating whether translating of codes is configured to true in inquiry definition

    • isLookupFieldTriggerOnChange

      boolean isLookupFieldTriggerOnChange(Class businessObjectClass, String attributeName)
      Deprecated.
      Indicates whether a lookup field has been configured to trigger on value change
      Parameters:
      businessObjectClass - - Class for business object to lookup
      attributeName - - name of attribute in the business object to check configuration for
      Returns:
      true if field is configured to trigger on value change, false if not

    • disableSearchButtonsInLookup

      boolean disableSearchButtonsInLookup(Class businessObjectClass)
      Deprecated.
      Indicates whether the search and clear buttons should be disabled based on the data dictionary configuration
      Parameters:
      businessObjectClass - - business object class for lookup definition
      Returns:
      Boolean indicating whether disable search buttons is configured to true in lookup definition