Package com.ptc.projectmanagement.plan

Interface HealthStatusIconHandler

All Known Implementing Classes:
PlannableHealthStatusIconHandler
public interface HealthStatusIconHandler
Use: This interface can be used to extend the capabilities for changing health status icons as per custom needs.

Supported API: true

Extendable: true

  • Method Details

    • getHealthStatusImageIcon

      HashMap<Object,Object> getHealthStatusImageIcon(List objects)
      Use: This API returns the HashMap containing the set of activities or floating baseline members along with their IconComponents.

      Supported API: true
      Parameters:
      List - objects
      Returns:
      HashMap<Object, Object>

    • getIcon

      Object getIcon(HealthStatusType healthStatusType, boolean isComplete, boolean isCancelled, AbstractPlanActivity activity) throws WTException, WTPropertyVetoException
      Use: This API 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 the textual representation of the health status.
      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

      String getIconForCompletedLate()
      Return relative path of the icon for plannables that are completed late. e.g. "netmarkets/images/late_completed_activities.png"

      Supported API: true
      Returns:
      String (relative path of icon to be used for late completed plannables)

    • getIconForCompletedPlannables

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

      Supported API: true
      Returns:
      String (relative path of icon to be used for completed plannables)

    • getIconForCancelledPlannables

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

      Supported API: true
      Returns:
      String (relative path of icon to be used for cancelled plannables)

    • getIcon

      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.
      Parameters:
      BaseHealthStatusType - healthStatusTypeFBML
      Returns:
      Object
      Throws:
      WTException -

      Supported API: true