Package com.ptc.projectmanagement.plannable

Class StandardPlannableService

java.lang.Object

wt.services.StandardManager

com.ptc.projectmanagement.plannable.StandardPlannableService

All Implemented Interfaces:

PlannableService, Serializable, wt.fc._NetFactor, NetFactor, wt.services.Manager

public class StandardPlannableService
extends StandardManager
implements PlannableService, Serializable

Use the newStandardPlannableService static factory method(s), not the StandardPlannableService 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:

• Serialized Form

Method Summary

Modifier and Type	Method	Description
WTKeyedHashMap	getAllAncestorsOfActivities(WTCollection activityList)	For the given activity list, returns WTKeyedHashMap(PlanActivity, WTArrayList(PlanActivity)) where key is the given activity and value is the WTArrayList of all it's ancestors. Note: If any activity don't have parent summary activity and its parent is plan then the empty WTArrayList(PlanActivity) would be returned in the WTKeyedHashMap(PlanActivity, WTArrayList(PlanActivity)) Supported API: true
WTCollection	getEligiblePlansActivitiesForTrackNewWork(String planOid)	USE : fetches the scheduled deliverable activities, which are not completed and in progress, associated with logged in user resource.
QuerySpec	getEligiblePlansActivitiesForTrackNewWorkQuerySpec(QuerySpec qs)	USE : Updates the given QuerySpec objects to fetch the scheduled deliverable activities, which are not completed and in progress, associated with logged in user resource.
Map<Scheduleable,ActivityHistoryRecord>	getHistoryRecordsForPlan(Plan plan)	Returns map containing all activities of a plan as key and value is the object of 'ActivityHistoryRecord'.
WTCollection	getLeafActivitiesForSummary(Plannable plannable)	USE : This API will return all leaf activities for given set of summary activities and Plan Supported API: true
long[]	getPlanActivitiesForNewActivity(String planOid)	USE : Fetches all the activities and milestones (apart from dummy) for a given plan.
HashMap<String,WTArrayList>	getScheduledDeliverablesWithAutomaticCalculationMode(Plannable plannable)	USE : This API will return all leaf activities having automatic health status , automatic deadline calculation mode, which are schedule deliverable and not completed for given set of summary activities and Plan.
WTKeyedHashMap	getSummaryActivities(WTCollection childActivities)	This API will return all summary activities for given set of leaf/summary activities Supported API: true
void	invokeCalculateDeadlineAndHealthStatusForAutoModeActivities(HashMap<String,WTArrayList> scheduleDeliverablesForAutoMode)	USE : This API will call calculate Health Status and Deadline methods for Auto Mode Activities Supported API: true

Methods inherited from class wt.services.StandardManager

getManagerService, getManagerStatus, getName, getStartupType, initialize, performShutdownProcess, registerEvents

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Details

getHistoryRecordsForPlan

public Map<Scheduleable,ActivityHistoryRecord> getHistoryRecordsForPlan(Plan plan)
                                                                 throws WTException

Returns map containing all activities of a plan as key and value is the object of 'ActivityHistoryRecord'.

Supported API: true

Specified by:

getHistoryRecordsForPlan in interface PlannableService

Parameters:

Plan -

Returns:

Map<Scheduleable,ActivityHistoryRecord>

Throws:

WTException

getEligiblePlansActivitiesForTrackNewWorkQuerySpec

public QuerySpec getEligiblePlansActivitiesForTrackNewWorkQuerySpec(QuerySpec qs)
                                                             throws WTException

USE : Updates the given QuerySpec objects to fetch the scheduled deliverable activities, which are not completed and in progress, associated with logged in user resource. Supported API: true

Specified by:

getEligiblePlansActivitiesForTrackNewWorkQuerySpec in interface PlannableService

Returns:

- updated QuerySpec object

Throws:

WTException - - when an error occurred while building query spec.

getEligiblePlansActivitiesForTrackNewWork

public WTCollection getEligiblePlansActivitiesForTrackNewWork(String planOid)
                                                       throws WTException

USE : fetches the scheduled deliverable activities, which are not completed and in progress, associated with logged in user resource. Supported API: true

Specified by:

getEligiblePlansActivitiesForTrackNewWork in interface PlannableService

Returns:

- list of activities

Throws:

WTException - - when an error occurred while building query spec.

getPlanActivitiesForNewActivity

public long[] getPlanActivitiesForNewActivity(String planOid)
                                       throws WTException

USE : Fetches all the activities and milestones (apart from dummy) for a given plan. Supported API: true

Specified by:

getPlanActivitiesForNewActivity in interface PlannableService

Returns:

- array of long data-type containing the oids of activities

Throws:

WTException - - when an error occurred while building query spec.

getLeafActivitiesForSummary

public WTCollection getLeafActivitiesForSummary(Plannable plannable)
                                         throws WTException

USE : This API will return all leaf activities for given set of summary activities and Plan

Supported API: true

Specified by:

getLeafActivitiesForSummary in interface PlannableService

Returns:

WTCollection - list of all leaf activities

Throws:

WTException

getScheduledDeliverablesWithAutomaticCalculationMode

public HashMap<String,WTArrayList> getScheduledDeliverablesWithAutomaticCalculationMode(Plannable plannable)
                                                                                 throws WTException

USE : This API will return all leaf activities having automatic health status , automatic deadline calculation mode, which are schedule deliverable and not completed for given set of summary activities and Plan.

Supported API: true

Specified by:

getScheduledDeliverablesWithAutomaticCalculationMode in interface PlannableService

Returns:

HashMap<String,WTArrayList> - Map of list containing all the activities having automatic health status & deadline , automatic Health status , automatic deadline calculation mode.

Throws:

WTException

invokeCalculateDeadlineAndHealthStatusForAutoModeActivities

public void invokeCalculateDeadlineAndHealthStatusForAutoModeActivities(HashMap<String,WTArrayList> scheduleDeliverablesForAutoMode)
                                                                 throws WTException,
WTPropertyVetoException

USE : This API will call calculate Health Status and Deadline methods for Auto Mode Activities

Supported API: true

Specified by:

invokeCalculateDeadlineAndHealthStatusForAutoModeActivities in interface PlannableService

Throws:

WTPropertyVetoException

WTException

getSummaryActivities

public WTKeyedHashMap getSummaryActivities(WTCollection childActivities)
                                    throws WTException

This API will return all summary activities for given set of leaf/summary activities

Supported API: true

Specified by:

getSummaryActivities in interface PlannableService

Returns:

WTKeyedHashMap summaryMap - map, key being the leaf activity and the summary as its value

Throws:

WTException

getAllAncestorsOfActivities

public WTKeyedHashMap getAllAncestorsOfActivities(WTCollection activityList)
                                           throws WTException

For the given activity list, returns WTKeyedHashMap(PlanActivity, WTArrayList(PlanActivity)) where key is the given activity and value is the WTArrayList of all it's ancestors.
Note: If any activity don't have parent summary activity and its parent is plan then the empty WTArrayList(PlanActivity) would be returned in the WTKeyedHashMap(PlanActivity, WTArrayList(PlanActivity))

Supported API: true

Specified by:

getAllAncestorsOfActivities in interface PlannableService

Parameters:

activityList -

Returns:

WTKeyedHashMap

Throws:

WTException