Class RelationshipCreateRequest

  • All Implemented Interfaces:
    java.io.Serializable

    public class RelationshipCreateRequest
    extends OMRSAPIRequest
    RelationshipCreateRequest provides the bean to hold all the properties needed to create a new relationship.
    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.
      java.lang.String getEntityOneGUID()
      Return the unique identifier (GUID) for the first entity linked by the relationship.
      java.lang.String getEntityTwoGUID()
      Return the unique identifier (GUID) for the second entity linked by the relationship.
      org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties getInitialProperties()
      Return the list of properties for the new relationship.
      org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceStatus getInitialStatus()
      Return the initial status for the new relationship.
      java.lang.String getMetadataCollectionId()
      Return the metadata collection id for this new relationship
      java.lang.String getMetadataCollectionName()
      Return the name of the metadata collection for this new relationship.
      java.lang.String getRelationshipTypeGUID()
      Return the type of the new relationship.
      int hashCode()
      Create a hash code for this element type.
      void setEntityOneGUID​(java.lang.String entityOneGUID)
      Set up the unique identifier (GUID) for the first entity linked by the relationship.
      void setEntityTwoGUID​(java.lang.String entityTwoGUID)
      Set up the unique identifier (GUID) for the second entity linked by the relationship.
      void setInitialProperties​(org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties initialProperties)
      Set up the initial properties for the relationship.
      void setInitialStatus​(org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceStatus initialStatus)
      Set up the initial status for the new relationship.
      void setMetadataCollectionId​(java.lang.String metadataCollectionId)
      Set up the metadata collection id for this new relationship.
      void setMetadataCollectionName​(java.lang.String metadataCollectionName)
      Set up the name of the metadata collection for this new relationship.
      void setRelationshipTypeGUID​(java.lang.String relationshipTypeGUID)
      Set up the type of the 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

      • RelationshipCreateRequest

        public RelationshipCreateRequest()
        Default constructor
      • RelationshipCreateRequest

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

      • getRelationshipTypeGUID

        public java.lang.String getRelationshipTypeGUID()
        Return the type of the new relationship.
        Returns:
        String guid
      • setRelationshipTypeGUID

        public void setRelationshipTypeGUID​(java.lang.String relationshipTypeGUID)
        Set up the type of the new relationship.
        Parameters:
        relationshipTypeGUID - String guid
      • getInitialProperties

        public org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties getInitialProperties()
        Return the list of properties for the new relationship.
        Returns:
        instance properties object
      • setInitialProperties

        public void setInitialProperties​(org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties initialProperties)
        Set up the initial properties for the relationship.
        Parameters:
        initialProperties - InstanceProperties object
      • getEntityOneGUID

        public java.lang.String getEntityOneGUID()
        Return the unique identifier (GUID) for the first entity linked by the relationship.
        Returns:
        entity guid
      • setEntityOneGUID

        public void setEntityOneGUID​(java.lang.String entityOneGUID)
        Set up the unique identifier (GUID) for the first entity linked by the relationship.
        Parameters:
        entityOneGUID - entity guid
      • getEntityTwoGUID

        public java.lang.String getEntityTwoGUID()
        Return the unique identifier (GUID) for the second entity linked by the relationship.
        Returns:
        entity guid
      • setEntityTwoGUID

        public void setEntityTwoGUID​(java.lang.String entityTwoGUID)
        Set up the unique identifier (GUID) for the second entity linked by the relationship.
        Parameters:
        entityTwoGUID - entity guid
      • getInitialStatus

        public org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceStatus getInitialStatus()
        Return the initial status for the new relationship.
        Returns:
        instance status enum
      • setInitialStatus

        public void setInitialStatus​(org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceStatus initialStatus)
        Set up the initial status for the new relationship.
        Parameters:
        initialStatus - instance status enum
      • getMetadataCollectionId

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

        public void setMetadataCollectionId​(java.lang.String metadataCollectionId)
        Set up the metadata collection id for this new relationship. This field is optional for addRelationship and mandatory for addExternalRelationship.
        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