Package hec.data.rating

Interface IRatingTemplate

All Known Implementing Classes:
JDomRatingTemplate
public interface IRatingTemplate
An interface on to a rating template. Has an office id, parameters, and version.

  • Field Details

    • INDEP_PARAM_DELIM

      static final String INDEP_PARAM_DELIM
      The delimeter for the independent parameters.
      See Also:

    • INDEP_DEP_DELIM

      static final String INDEP_DEP_DELIM
      The delimeter between the independent and dependent parameters.
      See Also:

    • PART_DELIM

      static final String PART_DELIM
      The delimeter between the parameters and version.
      See Also:

  • Method Details

    • getOfficeId

      DbOfficeId getOfficeId()
      Returns the office id for this template.
      Returns:

    • setOfficeId

      void setOfficeId(DbOfficeId officeId)
      Sets the office id for this template.
      Parameters:
      officeId -

    • getIndependentParameterList

      List<Parameter> getIndependentParameterList()
      Returns an ordered listing of the independent parameters for this template.
      Returns:

    • setIndependentParameterList

      void setIndependentParameterList(List<Parameter> independentParameterList)
      Sets the independent parameters for this template to the ordered arg list.
      Parameters:
      independentParameterList -

    • getDependentParameter

      Parameter getDependentParameter()
      Returns the dependent parameter for this template.
      Returns:

    • setDependentParameter

      void setDependentParameter(Parameter dependentParameter)
      Sets the dependent parameter for this template.
      Parameters:
      dependentParameter -

    • getTemplateVersion

      Version getTemplateVersion()
      Returns the version for this template. Note that a spec also has a version separate from the template version.
      Returns:

    • setTemplateVersion

      void setTemplateVersion(Version version)
      Sets the version for this template. Note that a spec also has a version separate from the template version.
      Parameters:
      version -

    • isSimple

      boolean isSimple()
      If the rating has 1 independent parameter : 1 dependent parameter. I.e. it can be used for reverse ratings.
      Returns:

    • getIndependentParameterCount

      int getIndependentParameterCount()
      Returns a count of the independent parameters.
      Returns: