Package com.ptc.projectmanagement.plan

Class StandardPlanService

java.lang.Object
wt.services.StandardManager
com.ptc.projectmanagement.plan.StandardPlanService
All Implemented Interfaces:
PlanService, Serializable, wt.fc._NetFactor, NetFactor, wt.services.Manager
public class StandardPlanService extends StandardManager implements PlanService, Serializable

Use the newStandardPlanService static factory method(s), not the StandardPlanService constructor, to construct instances of this class. Instances must be constructed using the static factory(s), in order to ensure proper initialization of the instance.



Supported API: true

Extendable: false

See Also:

  • Method Details

    • getPlan

      @Deprecated public Rootable getPlan(ObjectReference planHolder) throws WTException
      Deprecated.
      Starting from Athens release, A planHolder can have multiple plans, consider using getPlans(planHolder) instead of this. Should you need default plan for the container, use getDefaultPlan() API instead.

      Supported API: true
      Specified by:
      getPlan in interface PlanService
      Returns:
      Rootable
      Throws:
      WTException

    • getPlan

      @Deprecated public Rootable getPlan(ObjectReference planHolder, boolean includeDeleted) throws WTException
      Deprecated.
      Starting from Athens release, A planHolder can have multiple plans, consider using getPlans(planHolder) instead of this. Should you need default plan for the container, use getDefaultPlan() API instead.

      Supported API: true
      Specified by:
      getPlan in interface PlanService
      Returns:
      Rootable
      Throws:
      WTException

    • getPlans

      public WTList getPlans(ObjectReference planHolder) throws WTException
      Given a plan holder, returns a list of associated Plans (objects that implement the interface com.ptc.projectmanagement.plannable.Rootable and that are not BaselinedPlan instances).

      Supported API: true
      Specified by:
      getPlans in interface PlanService
      Parameters:
      planHolder - - an ObjectReference to the input plan holder.
      Returns:
      - a WTList of Plans (other than BaselinedPlans) that are associated to the input plan holder.
      Throws:
      WTException - , if an error occurred while building or executing the relevant database query.

    • getPlannableContents

      public WTCollection getPlannableContents(Plan plan) throws WTException


      Supported API: true
      Specified by:
      getPlannableContents in interface PlanService
      Returns:
      WTCollection
      Throws:
      WTException

    • getEligiblePlansForTrackNewWork

      public WTCollection getEligiblePlansForTrackNewWork(long[] containerOids) throws WTException, WTPropertyVetoException
      USE: Given a plan holder, returns a list of associated Plans having one or more inprocess scheduled deliverables having logged in user as a resource. Supported API: true
      Specified by:
      getEligiblePlansForTrackNewWork in interface PlanService
      Parameters:
      containerOids - - list of oids for containers
      Returns:
      - a WTCollection of Plans (other than BaselinedPlans) that are associated to the input container having one or more scheduled deliverables in it, which are inprogress state and not completed.
      Throws:
      WTException - - when an error occurred while building or executing the relevant database query.
      WTPropertyVetoException

    • getEligiblePlansForNewPlanActivityWizard

      public WTCollection getEligiblePlansForNewPlanActivityWizard(long[] containerOids) throws WTException, WTPropertyVetoException
      USE: Given a plan holder, returns a list of Eligible Manual and Auto (Scheduled/In-Progress/Suspended) Plans. Supported API: true
      Specified by:
      getEligiblePlansForNewPlanActivityWizard in interface PlanService
      Parameters:
      containerOids - - list of oids for containers
      Returns:
      - a WTCollection of Eligible Plans.
      Throws:
      WTException - - when an error occurred while building or executing the relevant database query.
      WTPropertyVetoException