Kuali Rice Development
  1. Kuali Rice Development
  2. KULRICE-9526

Document which classes have been deprecated and why they have been deprecated

    Details

    • Type: Task Task
    • Status: Closed Closed
    • Priority: Major Major
    • Resolution: Complete
    • Affects Version/s: None
    • Fix Version/s: 2.4
    • Component/s: Documentation, JPA, Roadmap
    • Security Level: Public (Public: Anyone can view)
    • Labels:
      None
    • Similar issues:
      KULRICE-1735Deprecate DocumentBase.getDocumentRepresentationForSerialization()
      KULRICE-10023Deprecate SequenceAccessorService in favor of MaxValueIncrementerFactory
      KULRICE-9889Move deprecated data code and services to the rice-kns module
      KULRICE-13019Deprecate Lightbox methods and add Dialog equivalents for migration
      KULRICE-9393Determine how best to deprecate ObjectUtils so that it's not referenced from non-legacy KRAD code
      KULRICE-9552Deprecate old business object classes and document replacements (if any)
      KULRICE-10149Remove all reference to now deprecated SequenceAccessorService and DatabasePlatform.getNextValueSQL
      KULRICE-9017Column defaults have been munged
      KULRICE-5333Mark all KNS classes (in kns module and kns packages of other module like impl) as deprecated
      KULRICE-12722Moving of the deprecated Global Document classes
    • Rice Module:
      KRAD
    • KRAD Feature Area:
      Data Dictionary, Persistence Framework
    • Sprint:
      2.4.0-rc1 Sprint 6
    • KAI Review Status:
      Not Required
    • KTI Review Status:
      Not Required
    • Code Review Status:
      Not Required
    • Include in Release Notes?:
      Yes

      Description

      This information will be available in javadocs as well, but we should write up some kind of high-level summary on what has been deprecated and why as it pertains to proper usage of the framework.

      Examples, sequence accessor, business object service, persistable business object, etc.

        Activity

        Hide
        Kristina Taylor (Inactive) added a comment -

        Where would we document this and how specific should we be?

        Show
        Kristina Taylor (Inactive) added a comment - Where would we document this and how specific should we be?
        Hide
        Eric Westfall added a comment -

        This is a release notes item, though it's going to probably be a bit of a big list to document I imagine. Maybe just something along the lines of a statement that says a number of persistence-framework related classes from KRAD have been deprecated in favor of new services provided by the krad-data module. Most of these have also been moved to the KNS module code (though their package remains the same). Some examples of deprecated classes include:

        • org.kuali.rice.krad.service.BusinessObjectService
        • org.kuali.rice.krad.service.DataObjectMetaDataService
        • org.kuali.rice.krad.service.KeyValuesService
        • org.kuali.rice.krad.service.PersistenceService
        • org.kuali.rice.krad.service.PersistenceStructureService
        • org.kuali.rice.krad.service.SequenceAccessorService
        • org.kuali.rice.krad.service.SessionDocumentService
        • org.kuali.rice.krad.util.ObjectUtils
        • org.kuali.rice.core.api.criteria.CriteriaLookupService
        • org.kuali.rice.krad.bo.BusinessObjectBase
        • org.kuali.rice.krad.bo.PersistableBusinessObject
        • org.kuali.rice.krad.bo.PersistableBusinessObjectBase
        • org.kuali.rice.krad.bo.PersistableBusinessObjectExtension
        • plus more...

        Please see the specific javadocs on these classes for information on what has replaced them.

        Show
        Eric Westfall added a comment - This is a release notes item, though it's going to probably be a bit of a big list to document I imagine. Maybe just something along the lines of a statement that says a number of persistence-framework related classes from KRAD have been deprecated in favor of new services provided by the krad-data module. Most of these have also been moved to the KNS module code (though their package remains the same). Some examples of deprecated classes include: org.kuali.rice.krad.service.BusinessObjectService org.kuali.rice.krad.service.DataObjectMetaDataService org.kuali.rice.krad.service.KeyValuesService org.kuali.rice.krad.service.PersistenceService org.kuali.rice.krad.service.PersistenceStructureService org.kuali.rice.krad.service.SequenceAccessorService org.kuali.rice.krad.service.SessionDocumentService org.kuali.rice.krad.util.ObjectUtils org.kuali.rice.core.api.criteria.CriteriaLookupService org.kuali.rice.krad.bo.BusinessObjectBase org.kuali.rice.krad.bo.PersistableBusinessObject org.kuali.rice.krad.bo.PersistableBusinessObjectBase org.kuali.rice.krad.bo.PersistableBusinessObjectExtension plus more... Please see the specific javadocs on these classes for information on what has replaced them.

          People

          • Assignee:
            Kristina Taylor (Inactive)
            Reporter:
            Eric Westfall
          • Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Time Tracking

              Estimated:
              Original Estimate - 2 days
              2d
              Remaining:
              Remaining Estimate - 0 minutes
              0m
              Logged:
              Time Spent - 6 hours Time Not Required
              6h

                Agile

                  Structure Helper Panel