Class RelatedAssetElement

  • All Implemented Interfaces:
    java.io.Serializable, MetadataElement

    public class RelatedAssetElement
    extends java.lang.Object
    implements MetadataElement, java.io.Serializable
    RelatedAssetElement contains the properties and header for a relationship to an asset retrieved from the metadata repository. The related asset is returned as well.
    See Also:
    Serialized Form
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object objectToCompare)
      Return comparison result based on the content of the properties.
      java.util.Date getEffectiveFrom()
      Return the date/time that this element is effective from (null means effective from the epoch).
      java.util.Date getEffectiveTo()
      Return the date/time that element is effective to (null means that it is effective indefinitely into the future).
      ElementHeader getElementHeader()
      Return the element header associated with the relationship.
      java.util.Map<java.lang.String,​java.lang.Object> getProperties()
      Return the properties for the relationship.
      AssetElement getRelatedAsset()
      Return the properties for the related asset.
      int hashCode()
      Return hash code for this object
      void setEffectiveFrom​(java.util.Date effectiveFrom)
      Set up the date/time that this element is effective from (null means effective from the epoch).
      void setEffectiveTo​(java.util.Date effectiveTo)
      Set the date/time that element is effective to (null means that it is effective indefinitely into the future).
      void setElementHeader​(ElementHeader elementHeader)
      Set up the element header associated with the relationship.
      void setProperties​(java.util.Map<java.lang.String,​java.lang.Object> properties)
      Set up the properties for the relationship.
      void setRelatedAsset​(AssetElement relatedAsset)
      Set up the properties for the related asset.
      java.lang.String toString()
      JSON-style toString
      • Methods inherited from class java.lang.Object

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

      • RelatedAssetElement

        public RelatedAssetElement()
        Default constructor
      • RelatedAssetElement

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

      • setElementHeader

        public void setElementHeader​(ElementHeader elementHeader)
        Set up the element header associated with the relationship.
        Specified by:
        setElementHeader in interface MetadataElement
        Parameters:
        elementHeader - element header object
      • getProperties

        public java.util.Map<java.lang.String,​java.lang.Object> getProperties()
        Return the properties for the relationship.
        Returns:
        relationship properties (using appropriate subclass)
      • setProperties

        public void setProperties​(java.util.Map<java.lang.String,​java.lang.Object> properties)
        Set up the properties for the relationship.
        Parameters:
        properties - asset properties
      • getEffectiveFrom

        public java.util.Date getEffectiveFrom()
        Return the date/time that this element is effective from (null means effective from the epoch).
        Returns:
        date object
      • setEffectiveFrom

        public void setEffectiveFrom​(java.util.Date effectiveFrom)
        Set up the date/time that this element is effective from (null means effective from the epoch).
        Parameters:
        effectiveFrom - date object
      • getEffectiveTo

        public java.util.Date getEffectiveTo()
        Return the date/time that element is effective to (null means that it is effective indefinitely into the future).
        Returns:
        date object
      • setEffectiveTo

        public void setEffectiveTo​(java.util.Date effectiveTo)
        Set the date/time that element is effective to (null means that it is effective indefinitely into the future).
        Parameters:
        effectiveTo - date object
      • getRelatedAsset

        public AssetElement getRelatedAsset()
        Return the properties for the related asset.
        Returns:
        asset properties (using appropriate subclass)
      • setRelatedAsset

        public void setRelatedAsset​(AssetElement relatedAsset)
        Set up the properties for the related asset.
        Parameters:
        relatedAsset - asset properties
      • toString

        public java.lang.String toString()
        JSON-style toString
        Overrides:
        toString in class java.lang.Object
        Returns:
        return string containing the property names and values
      • equals

        public boolean equals​(java.lang.Object objectToCompare)
        Return comparison result based on the content of the properties.
        Overrides:
        equals in class java.lang.Object
        Parameters:
        objectToCompare - test object
        Returns:
        result of comparison
      • hashCode

        public int hashCode()
        Return hash code for this object
        Overrides:
        hashCode in class java.lang.Object
        Returns:
        int hash code