Enum Class ClassificationOrigin

All Implemented Interfaces:
Serializable, Comparable<ClassificationOrigin>, Constable

public enum ClassificationOrigin extends Enum<ClassificationOrigin>
ClassificationOrigin describes the provenance of a classification attached to an entity. Most classifications are explicitly assigned to an entity. However, it is possible for some classifications to flow along relationships to other entities. These are the propagated classifications. Each entity can only have one classification of a certain type. A propagated classification can not override an assigned classification. Classifications can only be attached to entities of specific types. However a propagated classification can flow through an entity that does not support the particular type of classification and then on to other relationships attached to the entity. The ClassificationPropagateRule in the relationship's RelationshipDef defines where the classification can flow to.

Note: the repository services have no mechanism to automatically propagate classifications. This is set up by higher level services working with knowledge of the specific instance types of metadata and their significance.
  • Enum Constant Details


      public static final ClassificationOrigin ASSIGNED
      The classification is explicitly assigned to the entity.

      public static final ClassificationOrigin PROPAGATED
      The classification has propagated along a relationship to this entity.
  • Method Details

    • values

      public static ClassificationOrigin[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static ClassificationOrigin valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      name - the name of the enum constant to be returned.
      the enum constant with the specified name
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null
    • getOrdinal

      public int getOrdinal()
      Return the numeric representation of the classification origin.
      int ordinal
    • getName

      public String getName()
      Return the default name of the classification origin.
      String name
    • getDescription

      public String getDescription()
      Return the default description of the classification origin.
      String description
    • toString

      public String toString()
      toString() JSON-style
      toString in class Enum<ClassificationOrigin>
      string description