Class ClassificationRequest

  • All Implemented Interfaces:
    java.io.Serializable

    public class ClassificationRequest
    extends OMRSAPIRequest
    ClassificationRequest carries the properties needed to create a classification.
    See Also:
    Serialized Form
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object objectToCompare)
      Compare the values of the supplied object with those stored in the current object.
      org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.ClassificationOrigin getClassificationOrigin()
      Return the origin of the classification.
      java.lang.String getClassificationOriginGUID()
      Return the guid of the entity where a propagate classification came from.
      org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties getClassificationProperties()
      Return the list of properties for the new entity.
      java.lang.String getMetadataCollectionId()
      Return the metadata collection id for this new entity
      java.lang.String getMetadataCollectionName()
      Return the name of the metadata collection for this new relationship.
      int hashCode()
      Create a hash code for this element type.
      void setClassificationOrigin​(org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.ClassificationOrigin classificationOrigin)
      Set up the origin of the classification.
      void setClassificationOriginGUID​(java.lang.String classificationOriginGUID)
      Set up the guid of the entity where a propagate classification came from.
      void setClassificationProperties​(org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties classificationProperties)
      Set up the initial properties for the entity.
      void setMetadataCollectionId​(java.lang.String metadataCollectionId)
      Set up the metadata collection id for this new entity.
      void setMetadataCollectionName​(java.lang.String metadataCollectionName)
      Set up the name of the metadata collection for this new relationship.
      java.lang.String toString()
      Standard toString method.
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • ClassificationRequest

        public ClassificationRequest()
        Default constructor
      • ClassificationRequest

        public ClassificationRequest​(ClassificationRequest template)
        Copy/clone constructor
        Parameters:
        template - object to copy
    • Method Detail

      • getClassificationOrigin

        public org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.ClassificationOrigin getClassificationOrigin()
        Return the origin of the classification.
        Returns:
        ClassificationOrigin enum
      • setClassificationOrigin

        public void setClassificationOrigin​(org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.ClassificationOrigin classificationOrigin)
        Set up the origin of the classification.
        Parameters:
        classificationOrigin - ClassificationOrigin enum
      • getClassificationOriginGUID

        public java.lang.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​(java.lang.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 org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties getClassificationProperties()
        Return the list of properties for the new entity.
        Returns:
        instance properties object
      • setClassificationProperties

        public void setClassificationProperties​(org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties classificationProperties)
        Set up the initial properties for the entity.
        Parameters:
        classificationProperties - InstanceProperties object
      • getMetadataCollectionId

        public java.lang.String getMetadataCollectionId()
        Return the metadata collection id for this new entity
        Returns:
        guid
      • setMetadataCollectionId

        public void setMetadataCollectionId​(java.lang.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 java.lang.String getMetadataCollectionName()
        Return the name of the metadata collection for this new relationship.
        Returns:
        name
      • setMetadataCollectionName

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

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

        public boolean equals​(java.lang.Object objectToCompare)
        Compare the values of the supplied object with those stored in the current object.
        Overrides:
        equals in class java.lang.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 java.lang.Object
        Returns:
        int hash code