Package org.odpi.openmetadata.repositoryservices.rest.properties

Class ClassificationRequest

java.lang.Object
org.odpi.openmetadata.repositoryservices.rest.properties.OMRSAPIRequest
org.odpi.openmetadata.repositoryservices.rest.properties.ClassificationRequest
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
ClassificationProxyRequest
public class ClassificationRequest extends OMRSAPIRequest
ClassificationRequest carries the properties needed to create a classification.
See Also:

  • Constructor Details

    • ClassificationRequest

      public ClassificationRequest()
      Default constructor

    • ClassificationRequest

      public ClassificationRequest(ClassificationRequest template)
      Copy/clone constructor
      Parameters:
      template - object to copy

  • Method Details

    • getClassificationOrigin

      public ClassificationOrigin getClassificationOrigin()
      Return the origin of the classification.
      Returns:
      ClassificationOrigin enum

    • setClassificationOrigin

      public void setClassificationOrigin(ClassificationOrigin classificationOrigin)
      Set up the origin of the classification.
      Parameters:
      classificationOrigin - ClassificationOrigin enum

    • getClassificationOriginGUID

      public String getClassificationOriginGUID()
      Return the guid of the entity where a propagate classification came from.
      Returns:
      unique identifier of the classification's origin

    • setClassificationOriginGUID

      public void setClassificationOriginGUID(String classificationOriginGUID)
      Set up the guid of the entity where a propagate classification came from.
      Parameters:
      classificationOriginGUID - unique identifier of the classification's origin

    • getClassificationProperties

      public InstanceProperties getClassificationProperties()
      Return the list of properties for the new entity.
      Returns:
      instance properties object

    • setClassificationProperties

      public void setClassificationProperties(InstanceProperties classificationProperties)
      Set up the initial properties for the entity.
      Parameters:
      classificationProperties - InstanceProperties object

    • getMetadataCollectionId

      public String getMetadataCollectionId()
      Return the metadata collection id for this new entity
      Returns:
      guid

    • setMetadataCollectionId

      public void setMetadataCollectionId(String metadataCollectionId)
      Set up the metadata collection id for this new entity. This field is optional for addEntity and mandatory for addExternalEntity.
      Parameters:
      metadataCollectionId - guid

    • getMetadataCollectionName

      public String getMetadataCollectionName()
      Return the name of the metadata collection for this new relationship.
      Returns:
      name

    • setMetadataCollectionName

      public void setMetadataCollectionName(String metadataCollectionName)
      Set up the name of the metadata collection for this new relationship.
      Parameters:
      metadataCollectionName - name

    • toString

      public String toString()
      Standard toString method.
      Overrides:
      toString in class Object
      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 Object
      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 Object
      Returns:
      int hash code