Package org.ametys.odf.tree

Interface ODFTreeIndicator

All Superinterfaces:
Prioritizable
All Known Implementing Classes:
AbstractStaticODFTreeIndicator, CourseListTypeIndicator, CourseStepHolderIndicator, NotPublishableIndicator, ProgramItemCodeIndicator, SharedCoursePartIndicator, ShareStatusIndicator, WorkflowStepIndicator
public interface ODFTreeIndicator extends Prioritizable
Interface for an ODF tree indicator

  • Method Details

    • getId

      String getId()
      Get the id
      Returns:
      the id

    • getLabel

      I18nizableText getLabel()
      Get the indicator label
      Returns:
      the label

    • getDescription

      I18nizableText getDescription()
      Get the indicator description
      Returns:
      the description

    • getIconGlyph

      String getIconGlyph()
      The indicator glyph icon
      Returns:
      the CSS class for glyph icon

    • getScripts

      List<ClientSideElement.Script> getScripts(Map<String,Object> contextParameters)
      Get scripts that will be used on client side.
      Parameters:
      contextParameters - Contextuals parameters transmitted by the environment.
      Returns:
      The list of scripts or an empty list.

    • getMatchJSFunction

      String getMatchJSFunction()
      Get the JS function to determines if indicator is available for a content. Can return null to use default one.
      Returns:
      the JS function or null to use default matcher

    • getApplyJSFunction

      String getApplyJSFunction()
      Get the JS function to display the indicator. Can return null to use default one.
      Returns:
      the JS function or null to use default applyier

    • getIndicatorData

      ODFTreeIndicator.IndicatorData getIndicatorData(Content content)
      Get the indicator values for a program item. Return null if the indicator is not available for this program item
      Parameters:
      content - the content
      Returns:
      the indicator data for this program item. Can be null.