Interface Metric

All Superinterfaces:
Card
All Known Implementing Classes:
MetricImpl
public interface Metric extends Card
A Wikirate Metric is used to measure company performance. It is a way of asking the same question on many companies. The Metric entity extends the notion of a Card to provide additional information and functionality.
Author:
Vasiliki Gkatziaki

  • Method Details

    • getMetricDesigner

      String getMetricDesigner()
      Each metric has a designer, individuals or organizations are the most common designers of metrics on Wikirate
      Returns:
      the name of the metric designer

    • getMetricName

      String getMetricName()
      Each metric has a name which represents a shorter version of the questioned asked.
      Returns:
      the name of the metric

    • getMetricType

      MetricType getMetricType()
      There are different metric types. All the different options of a metric type can be found in enum class MetricType
      Returns:
      the metric type of the metric

    • getQuestion

      String getQuestion()
      Returns the question linked to the metric
      Returns:
      the question

    • getAbout

      String getAbout()
      Returns some more details about the metric (why this metric is important and how it is/can be used)
      Returns:
      a string

    • getMethodology

      String getMethodology()
      Description about how to research the answer
      Returns:
      a string

    • getValueType

      ValueType getValueType()
      There are different value types allowed on metrics. All the different options of a value type can be found in the enum class ValueType
      Returns:
      ValueType

    • getValueOptions

      List<String> getValueOptions()
      In case of a category on a multicategory value type, a list of value options is also defined.
      Returns:
      a list of the value options

    • getReportType

      ReportType getReportType()
      Report Type where the answers of the metric can be found in.
      Returns:
      ReportType

    • getAssessmentType

      AssessmentType getAssessmentType()
      Assessment type is applied on researched metrics, the research can either Community Assessed (anyone can research answers) or Steward Assessed (only stewards can research answers)
      Returns:
      AssessmentType

    • getUnit

      String getUnit()
      In case of Number value type a unit might also be defined.
      Returns:
      the unit of the value

    • getRange

      String getRange()
      In case of Number value type a range of values might also be defined (e.g. 0-100)
      Returns:

    • getTopics

      List<WikirateTopic> getTopics()
      A list of topics under Wikirate ESG Topic framework related to the metric
      Returns:
      list of topic names

    • getTopicFrameworks

      List<String> getTopicFrameworks()
      A list of topics under other frameworks (e.g. GRI Standards, ESRS Standards etc) related to the metric
      Returns:
      list of topic names

    • getFormula

      String getFormula()
      In case of a Formula metric type a formula is also defined in coffescript
      Returns:
      the formula in coffescript

    • getVariables

      List<String> getVariables()
      In case of a Formula metric type a number of variables are defined and used in the coffescript formula.
      Returns:
      a list of variables used on the formula

    • getNumberOfAnswers

      Integer getNumberOfAnswers()
      Number of answers this metric has.
      Returns:
      the number of answers

    • getNumberOfBookmarkers

      Integer getNumberOfBookmarkers()
      Number of users that bookmarked the metric
      Returns:
      the number of bookmarkers

    • getNumberOfDatasets

      Integer getNumberOfDatasets()
      Number of datasets the metric is included in
      Returns:
      number of datasets

    • getNumberOfCompanies

      Integer getNumberOfCompanies()
      Number of companies answer the question (metric)
      Returns:
      number of companies

    • getCalculations

      List<String> getCalculations()
      List of metric names the metric is used for additional calculations
      Returns:
      list of metric names

    • getAnswersURL

      String getAnswersURL()
      The URL the user can find the answers of the metric
      Returns:
      the answers url