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

Mark all KNS classes (in kns module and kns packages of other module like impl) as deprecated

    Details

    • Type: Task Task
    • Status: Closed Closed
    • Priority: Major Major
    • Resolution: Complete
    • Affects Version/s: 2.0
    • Fix Version/s: 2.4
    • Component/s: Development, Roadmap
    • Security Level: Public (Public: Anyone can view)
    • Labels:
      None
    • Similar issues:
      KULRICE-9889Move deprecated data code and services to the rice-kns module
      KULRICE-9556Move all deprecated data/persistence code to rice-kns module
      KULRICE-2079Move XAPoolDataSource from kns to shared module
      KULRICE-1442Develop and document a package naming standard for Rice modules
      KULRICE-1818Determine why we need to duplicate defaults in org.kuali.rice.TestBase in the KNS module
      KULRICE-6191Create an architecture diagram for KNS
      KULRICE-8154Location module uses KNS namespace 'KR-NS'
      KULRICE-6932ModuleServiceBase needs to be moved out of the rice "impl" module
      KULRICE-2867Determine which ExternalizableBusinessObjects should be defined in which of the two KNS module configurations
      KULRICE-10156Move PersistenceStructureService, PersistenceService, and friends to kns module
    • Rice Module:
      KRAD
    • Sprint:
      2.4.0-rc1 Sprint 5, 2.4.0-rc1 Sprint 6
    • KAI Review Status:
      Not Required
    • KTI Review Status:
      Not Required
    • Include in Release Notes?:
      Yes

      Description

      All KNS classes should be deprecated:

      1) Mark the method/class/package/etc. with @Deprecated annotation. This compiles the object's deprecated status in the .class file (and can even be accessed with reflection). When a client compiles against the class file, the compiler will issue a warning regardless of whether source/javadoc is present.

      2) Mark the method/class/package/etc. with @deprecated javadoc tag.
      Unlike, the annotation this tag allows us to put a description what why the thing is deprecated and what to do.

      For a complete example see below:

      /**

      • Get's your foo on.
        *
      • @deprecated this method doesn't work on certain edge cases. Please call {@link #doBarStuff()}

        instead.
        */
        @Deprecated
        public void doFooStuff() { }

        Issue Links

          Activity

          Hide
          Scott Gibson (Inactive) added a comment -

          If you completed can you resolve if not move to 2.1.

          Show
          Scott Gibson (Inactive) added a comment - If you completed can you resolve if not move to 2.1.
          Hide
          Jessica Coltrin (Inactive) added a comment -

          double-tagging with 2.0.0-b3 for review.

          Show
          Jessica Coltrin (Inactive) added a comment - double-tagging with 2.0.0-b3 for review.
          Hide
          Kristina Taylor (Inactive) added a comment - - edited

          We need to move the following classes to a KRAD equivalent as they are used in needed KRAD services:

          org.kuali.rice.kns.authorization.AuthorizationConstants (used in PessimisticLockService)
          org.kuali.rice.kns.datadictionary.validation.AttributeValidatingTypeServiceBase (used in KrmsTypeServiceBase)

          I have left them undeprecated. When the equivalents are created, please deprecate and document them.

          Show
          Kristina Taylor (Inactive) added a comment - - edited We need to move the following classes to a KRAD equivalent as they are used in needed KRAD services: org.kuali.rice.kns.authorization.AuthorizationConstants (used in PessimisticLockService) org.kuali.rice.kns.datadictionary.validation.AttributeValidatingTypeServiceBase (used in KrmsTypeServiceBase) I have left them undeprecated. When the equivalents are created, please deprecate and document them.

            People

            • Assignee:
              Kristina Taylor (Inactive)
              Reporter:
              Jerry Neal (Inactive)
            • Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Time Tracking

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

                  Agile

                    Structure Helper Panel