Class Contingency


  • public class Contingency
    extends java.lang.Object
    An object that defines a contingency.
    Since:
    100.13.0
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int getContingencyId()
      Gets the contingency's unique id.
      FeatureSubtype getSubtype()
      Gets the subtype to which this contingency is applied.
      java.util.Map<java.lang.String,​ContingentValue> getValues()
      Gets the contingency's values.
      boolean isRetired()
      Gets a boolean indicating if the contingency is retired or not.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Method Detail

      • getContingencyId

        public int getContingencyId()
        Gets the contingency's unique id.
        Returns:
        the contingency's unique id
        Since:
        100.13.0
      • isRetired

        public boolean isRetired()
        Gets a boolean indicating if the contingency is retired or not.

        When a contingency is retired, it means that its presence in existing data is acceptable, but that it should not be presented as an option when editing. It is typically used to express that a value is no longer valid, such as using asbestos as a building material.

        Returns:
        a boolean indicating if the contingency is retired or not
        Since:
        100.13.0
      • getSubtype

        public FeatureSubtype getSubtype()
        Gets the subtype to which this contingency is applied.
        Returns:
        the subtype to which this contingency is applied, or null if none
        Since:
        100.13.0
      • getValues

        public java.util.Map<java.lang.String,​ContingentValue> getValues()
        Gets the contingency's values.

        Returns a unmodifiable map of field names to the value defined for that field in this contingency.

        Returns:
        the contingency's values
        Since:
        100.13.0