Package com.ptc.projectmanagement.plan

Class PlannableHealthStatusIconHandler

java.lang.Object
com.ptc.projectmanagement.plan.PlannableHealthStatusIconHandler
All Implemented Interfaces:
HealthStatusIconHandler
public class PlannableHealthStatusIconHandler extends Object implements HealthStatusIconHandler
PlannableHealthStatusIconHandler - handler for returning health status icons.

Supported API: true

Extendable: true

  • Method Details

    • getIcon

      public Object getIcon(HealthStatusType healthStatusType, boolean isComplete, boolean isCancelled, AbstractPlanActivity activity) throws WTException, WTPropertyVetoException
      Use: This API will return the graphical 'health status' icon of activity. It will return Icon Component object for activity that is Completed/Cancelled or having status- Red/Yellow/Green/Unavailable. In any other cases, it would call the healthStatusType.getDisplay() method and return that object which is textual representation of the health status.
      Specified by:
      getIcon in interface HealthStatusIconHandler
      Parameters:
      HealthStatusType - healthStatusType boolean isComplete, boolean isCancelled, Locale locale, AbstractPlanActivity activity - This needs to be provided in order to check if activity has been completed on/before or after the deadline. pass this argument ONLY when you need icon for Activity and not for Plan or Resource Assignment.
      Returns:
      Object
      Throws:
      WTPropertyVetoException
      WTException -

      Supported API: true

    • getIconForCompletedLate

      public String getIconForCompletedLate()
      Returns relative path for the icon for plannables that are completed Late. e.g. "netmarkets/images/late_completed_activities.png"

      Supported API: true
      Specified by:
      getIconForCompletedLate in interface HealthStatusIconHandler
      Returns:

    • getIconForCompletedPlannables

      public String getIconForCompletedPlannables()
      Returns relative path for the icon for plannables that are completed. e.g. "netmarkets/images/completed_activities.png"

      Supported API: true
      Specified by:
      getIconForCompletedPlannables in interface HealthStatusIconHandler
      Returns:

    • getIconForCancelledPlannables

      public String getIconForCancelledPlannables()
      Returns relative path for the icon for plannables that are cancelled. e.g. "netmarkets/images/cancelled_activities.png"

      Supported API: true
      Specified by:
      getIconForCancelledPlannables in interface HealthStatusIconHandler
      Returns:

    • getHealthStatusImageIcon

      public HashMap<Object,Object> getHealthStatusImageIcon(List objectList)
      This API is called from the setModelData of the HealthStatusViewDataUtility.java. Handles icons for Activity, Plan, ResourceAssignment, SharedAssignment objects and Floating Baseline Member Link objects

      Supported API: true
      Specified by:
      getHealthStatusImageIcon in interface HealthStatusIconHandler
      Parameters:
      List - objectList
      Returns:
      HashMap<Object, Object> - <activity/Plan/ResourceAssignment/FloatingBaseline Member, icon component>

    • getIcon

      public HashMap<Object,Object> getIcon(FloatingBaselineMember fbmlObject, Object result, HashMap<Object,Object> iconList) throws WTException
      Use: This API will return the graphical 'health status' icon of floating baseline member. It will return Icon Component object for floating baseline member that is status- Red/Yellow/Green/Unavailable. In any other cases, it would call the healthStatusTypeFBML.getDisplay() method and return that object which is textual representation of the health status.
      Specified by:
      getIcon in interface HealthStatusIconHandler
      Parameters:
      BaseHealthStatusType - healthStatusTypeFBML
      Returns:
      Object
      Throws:
      WTException -

      Supported API: true

    • getStatusIcon

      protected IconComponent getStatusIcon(String imagePath, String toolTip)
      This API returns the Icon Component object after setting the path and tool-tip.

      Supported API: true
      Parameters:
      String - imagePath eg."netmarkets/images/cancelled_activities.png".
      String - toolTip.
      Returns:
      IconComponent object.