Package com.ptc.projectmanagement.plan

Interface PlanService

All Known Implementing Classes:
StandardPlanService
@RemoteInterface public interface PlanService


Supported API: true

Extendable: true

  • Method Details

    • createPlan

      Plan createPlan(String name, WTContainerRef containerRef, ObjectReference planHolderRef) throws WTException
      Deprecated.
      - use PlanHelper.service.createPlan(Rootable root).
      Creates and returns a new com.ptc.projectmanagement.Plan object given a planHolder reference and a container reference

      Supported API: true
      Parameters:
      name -
      containerRef -
      planHolderRef -
      Returns:
      Plan
      Throws:
      WTException

    • getPlan

      Rootable getPlan(ObjectReference planHolder) throws WTException
      Given a plan holder, returns the associated Plan (object that implements Rootable)

      Supported API: true
      Parameters:
      planHolder -
      Returns:
      Rootable
      Throws:
      WTException

    • getPlan

      Rootable getPlan(ObjectReference planHolder, boolean includeDeleted) throws WTException
      Overloaded method for getPlan(ObjectReference). Useful to retrieve the plan for a project Marked for deletion. Given a plan holder, returns the associated Plan (object that implements Rootable)

      Supported API: true
      Parameters:
      planHolder -
      Returns:
      Rootable
      Throws:
      WTException

    • getPlans

      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).

      Supported API: true
      Parameters:
      planHolder - - an ObjectReference to the input plan holder.
      Returns:
      - a WTList of Plans that are associated to the input plan holder.
      Throws:
      WTException

    • addToPlan

      Plannable addToPlan(Plannable plannable, Plannable parent) throws WTException
      Adds the specified Plannable to the Plan. The Plan is retrieved from parent

      Supported API: true
      Parameters:
      plannable - A pre-constructed Plannable
      parent -
      Returns:
      Plannable
      Throws:
      WTException

    • getPlannableContents

      WTCollection getPlannableContents(Plan plan) throws WTException
      Returns all Plannable objects that are part of the specified Plan

      Supported API: true
      Parameters:
      plan -
      Returns:
      WTCollection
      Throws:
      WTException

    • deletePlannableContents

      Plan deletePlannableContents(Plan plan) throws WTException
      Deletes the Plannable contents from the specified Plan. The Plan is returned (updated if necessary)

      Supported API: true
      Parameters:
      plan -
      Returns:
      Plan
      Throws:
      WTException

    • dispatchEvent

      void dispatchEvent(String eventType, Object target) throws WTException


      Supported API: true
      Parameters:
      eventType -
      target -
      Throws:
      WTException

    • createPlan

      Rootable createPlan(Rootable root) throws WTException
      Will persist and return a plan object that implements Rootable. Will emit the ProjectManagementEvent.NEW_PLAN after persisting. Will return null if the passed in Rootable object is not persisted.

      Supported API: true
      Parameters:
      root - Object that will hold the Plan. The object passed in should implement Rootable
      Returns:
      Rootable
      Throws:
      WTException

    • createPlan

      Plan createPlan(String name, WTContainerRef containerRef, ObjectReference planHolderRef, boolean isAutoExecution, boolean isLinkDeliverable, boolean isScheduledBackward) throws WTException
      Creates and returns a new com.ptc.projectmanagement.Plan object given name, container reference, planHolder reference, boolean isAutoExecution and boolean isLinkDeliverable and boolean isScheduledBackward.

      Supported API: true
      Parameters:
      name -
      containerRef -
      planHolderRef -
      isAutoExecution -
      isLinkDeliverable -
      isScheduledBackward -
      Returns:
      Plan
      Throws:
      WTException

    • createPlan

      Plan createPlan(String name, WTContainerRef containerRef, ObjectReference planHolderRef, boolean isAutoExecution, boolean isLinkDeliverable) throws WTException
      Creates and returns a new com.ptc.projectmanagement.Plan object given name, container reference, planHolder reference, boolean isAutoExecution and boolean isLinkDeliverable.

      Supported API: true
      Parameters:
      name -
      containerRef -
      planHolderRef -
      isAutoExecution -
      isLinkDeliverable -
      Returns:
      Plan
      Throws:
      WTException

    • getActiveEPPlanHolders

      List getActiveEPPlanHolders() throws WTException


      Supported API: true
      Throws:
      WTException

    • dispatchMultiEvent

      void dispatchMultiEvent(String eventType, WTCollection targets) throws WTException


      Supported API: true
      Parameters:
      eventType -
      target -
      Throws:
      WTException

    • suspendPlan

      void suspendPlan(Plan plan) throws WTException


      Supported API: true
      Parameters:
      plan -
      Throws:
      WTException

    • updatePlanName

      Plan updatePlanName(String newContextName, String oldContextName, ObjectReference planHolderRef) throws WTException
      Update a Plan Name for given Container Ref name, ObjectReference.

      Supported API: true
      Parameters:
      newContextName -
      planHolderRef -
      oldContextName -
      Returns:
      Plan
      Throws:
      WTException

    • resumePlan

      Plan resumePlan(Plan plan) throws WTException
      Resumes the given Plan by changing its state to Running.

      Supported API: true
      Parameters:
      plan -
      Returns:
      Plan
      Throws:
      WTException

    • getDefaultPlan

      Rootable getDefaultPlan(ObjectReference planHolder) throws WTException
      For project, returns the plan that gets created by default while creating the project. For product, returns the first plan created.

      Supported API: true
      Parameters:
      planHolder -
      Returns:
      Throws:
      WTException

    • getDefaultPlan

      Rootable getDefaultPlan(ObjectReference planHolder, boolean includeDeleted) throws WTException
      For project, returns the plan that gets created by default while creating the project. For product, returns the first plan created.

      Supported API: true
      Parameters:
      planHolder -
      includeDeleted -
      Returns:
      Throws:
      WTException

    • propagateScheduleForAllPlans

      void propagateScheduleForAllPlans(WTContainerRef containerRef) throws WTException


      Supported API: true
      Parameters:
      containerRef -
      Throws:
      WTException

    • getPlanCount

      int getPlanCount(ObjectReference planHolder) throws WTException
      For project, returns the number of plans project have.

      Supported API: true
      Parameters:
      planHolder -
      Returns:
      int
      Throws:
      WTException

    • getPlans

      Set<Rootable> getPlans(List<AbstractPlanActivity> activities) throws WTException
      Returns plans for a given collection of activities Supported API: true
      Parameters:
      List -
      Returns:
      Set<Rootable
      Throws:
      WTException

    • getEligiblePlansForTrackNewWork

      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
      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

    • getEligiblePlansForTrackNewWork

      org.json.JSONArray getEligiblePlansForTrackNewWork(long[] containerOids, boolean returnCountStar) throws WTException, WTPropertyVetoException
      USE: Given a plan holder, returns a list of associated Plans attributes having one or more inprocess scheduled deliverables having logged in user as a resource. Supported API: true
      Parameters:
      containerOids - - list of oids for containers
      returnCountStar - - when true only returns the count of associated plan otherwise return selected plan attributes
      Returns:
      - a JSONArray of plan attributes
      Throws:
      WTException - - when an error occurred while building or executing the relevant database query.
      WTPropertyVetoException

    • getEligiblePlansForNewPlanActivityWizard

      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
      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

    • dispatchEvent

      void dispatchEvent(String eventType) throws WTException
      Use: This API is used to dispatch event when there is no target object going to be affected through the event.

      Supported API: true
      Parameters:
      eventType -
      Throws:
      WTException

    • getPlansFromSummaryActivities

      WTHashSet getPlansFromSummaryActivities(WTCollection plannables) throws WTException
      This API will return all plans corresponding to summary activities

      Supported API: true
      Returns:
      WTCollection plans - set of plans corresponding to given summaries
      Throws:
      WTException

    • getProjectsForPlans

      WTHashSet getProjectsForPlans(WTCollection plans) throws WTException
      Use: This API will return a collection of projects for plans

      Supported API: true
      Parameters:
      plans -
      Returns:
      WTHashSet projects
      Throws:
      WTException