Package wt.change2.changeplanning

Class ChangePlanningHelper

java.lang.Object
wt.change2.changeplanning.ChangePlanningHelper
public class ChangePlanningHelper extends Object
Helper for the ChangePlanningService

Supported API: true

Extendable: false

  • Method Details

    • isPlanningSupported

      public static boolean isPlanningSupported(WTContainerRef containerRef)
      Whether or not the implementation planning for sequenced change tasks is supported.

      Will check for the following conditions:
      • ProjectLink is installed
      • ChangePlanningService is registered and available
      • The preference is enabled for the specified context.
      • The container reference is not null


      Supported API:true
      Parameters:
      containerRef - used to get the preference value
      See Also:

    • isPlanningSupported

      public static boolean isPlanningSupported()
      Determine whether or not planning functionality is supported in the system.

      Will check the following conditions:
      • ProjectLink installed
      • ChangePlanningService is registered and available


      Supported API:true
      Returns:
      Whether the system supported change planning.

    • isPlanningSupported

      public static boolean isPlanningSupported(VersionableChangeItem changeItem)
      Determine whether or not for the given change object whether the planning functionality is supported. Currently only the change notice and change activity are supported but this functionality might be expanded in the future. If a change activity is passed it will get the parent change notice and return value based on the change notice is associated to a Plan. If the passed in change activity is non planned and but the parent change notice is planned it will return true value.

      Will check the following conditions:
      • ProjectLink installed
      • ChangePlanningService is registered and available
      • The change object is not null
      • The change object has a plan or the change object's container enables planning being supported


      Supported API:true
      Parameters:
      changeItem - The change object to check whether planning is supported for it.
      Returns:

    • modifyPlan

      public static boolean modifyPlan(VersionableChangeItem changeItem, Map<? extends VersionableChangeItem,String> changePlanningSequence) throws WTException
      This will update the execution plan for given Versionable change item as per the change planning sequence map.
      1. Only change order can participate in the plan execution.
      2. Change activities associated to participating change order can be planned.
      3. Change order need to be reserved before performing update to execution plan.
      4. Modify permission on change order is required.
      5. Change order in implementation state without plan cannot be updated.
      6. For in progress change task, the sequence can be updated to blank or current execution value.
      7. Valid sequence values are either blank or in range of 1 to 1000.
      8. Sequence value of a change activity with workflow completed or plan executed cannot be updated.
      Note: Run the ChangeMgmtTest modules automated test for any update to this API and the associated private APIs.

      Supported API: true
      Parameters:
      changeItem - - For which plan is to be modified
      changePlanningSequence - - Versionable change item to sequence value map that are to be updated
      Returns:
      - true if the plan updated successfully.
      Throws:
      WTException