Uploaded image for project: '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
    • Status: Closed
    • Priority: 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
    • 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() { }

        Attachments

          Issue Links

            Activity

            Hide
            sgibson Scott Gibson (Inactive) added a comment -

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

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

            double-tagging with 2.0.0-b3 for review.

            Show
            jcoltrin Jessica Coltrin (Inactive) added a comment - double-tagging with 2.0.0-b3 for review.
            Hide
            kbtaylor 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
            kbtaylor 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:
                kbtaylor Kristina Taylor (Inactive)
                Reporter:
                jkneal 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