Class AttachedClassification


public class AttachedClassification extends ElementClassificationHeader
The AttachedClassification bean describes a single classification associated with an element.
  • Constructor Details

    • AttachedClassification

      public AttachedClassification()
      Default constructor
    • AttachedClassification

      public AttachedClassification(AttachedClassification template)
      Copy/clone constructor
      Parameters:
      template - template to copy
  • Method Details

    • setClassificationName

      public void setClassificationName(String classificationName)
      Set up the name of the classification. This name is the type name defined in a ClassificationDef type definition.
      Parameters:
      classificationName - name of classification
    • getClassificationName

      public String getClassificationName()
      Return the name of the classification
      Returns:
      String name
    • getEffectiveFromTime

      public Date getEffectiveFromTime()
      Return the date/time that this instance should start to be used (null means it can be used from creationTime).
      Returns:
      Date object
    • setEffectiveFromTime

      public void setEffectiveFromTime(Date effectiveFromTime)
      Set up the date/time that this instance should start to be used (null means it can be used from creationTime).
      Parameters:
      effectiveFromTime - Date object
    • getEffectiveToTime

      public Date getEffectiveToTime()
      Return the date/time that this instance should no longer be used.
      Returns:
      Date object
    • setEffectiveToTime

      public void setEffectiveToTime(Date effectiveToTime)
      Set up the date/time that this instance should no longer be used.
      Parameters:
      effectiveToTime - Date object
    • setClassificationProperties

      public void setClassificationProperties(ElementProperties classificationProperties)
      Set up a collection of the additional stored properties for the classification. If no stored properties are present then null is returned.
      Parameters:
      classificationProperties - properties for the classification
    • getClassificationProperties

      public ElementProperties getClassificationProperties()
      Return a collection of the additional stored properties for the classification. If no stored properties are present then null is returned.
      Returns:
      properties map
    • toString

      public String toString()
      Standard toString method.
      Overrides:
      toString in class ElementClassificationHeader
      Returns:
      print out of variables in a JSON-style
    • equals

      public boolean equals(Object objectToCompare)
      Compare the values of the supplied object with those stored in the current object.
      Overrides:
      equals in class ElementClassificationHeader
      Parameters:
      objectToCompare - supplied object
      Returns:
      boolean result of comparison
    • hashCode

      public int hashCode()
      Create a hash code for this element type.
      Overrides:
      hashCode in class ElementClassificationHeader
      Returns:
      int hash code