Class AssetElementHeader

  • All Implemented Interfaces:
    java.io.Serializable
    Direct Known Subclasses:
    AssetReferenceable

    public abstract class AssetElementHeader
    extends AssetPropertyElementBase
    ElementBase provides the common identifier and type information for all properties objects that link off of the asset and have a guid associated with them. This typically means it is represented by an entity in the metadata repository.
    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.util.List<ElementClassification> getClassifications()
      Return the list of classifications associated with the asset.
      protected ElementBase getElementHeaderBean()
      Return the element header bean - used during cloning
      java.util.Map<java.lang.String,​java.lang.Object> getExtendedProperties()
      Return any properties defined for a subtype that are not explicitly supported by the connected asset API.
      java.lang.String getGUID()
      Return the unique id for the properties object.
      ElementOrigin getOrigin()
      Return the element type properties for this properties object.
      ElementStatus getStatus()
      Return the status of the element.
      ElementType getType()
      Return the element type properties for this properties object.
      java.lang.String getURL()
      Returns the URL to access the properties object in the metadata repository.
      ElementVersions getVersions()
      Return the element version properties for this properties object.
      int hashCode()
      Create a hash code for this element type.
      protected void setBean​(ElementBase elementBaseBean)
      Set up the bean that contains the properties of the element header.
      java.lang.String toString()
      Standard toString method.
      • Methods inherited from class java.lang.Object

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

      • AssetElementHeader

        protected AssetElementHeader()
        Constructor used by the subclasses
      • AssetElementHeader

        protected AssetElementHeader​(ElementBase elementBaseBean)
        Bean constructor with parent asset
        Parameters:
        elementBaseBean - bean containing properties
      • AssetElementHeader

        protected AssetElementHeader​(AssetElementHeader assetElementHeader)
        Copy/clone constructor.
        Parameters:
        assetElementHeader - element to copy
    • Method Detail

      • setBean

        protected void setBean​(ElementBase elementBaseBean)
        Set up the bean that contains the properties of the element header.
        Parameters:
        elementBaseBean - bean containing all the properties
      • getElementHeaderBean

        protected ElementBase getElementHeaderBean()
        Return the element header bean - used during cloning
        Returns:
        bean
      • getType

        public ElementType getType()
        Return the element type properties for this properties object. These values are set up by the metadata repository and define details of the metadata entity used to represent this element.
        Returns:
        ElementType type information.
      • getOrigin

        public ElementOrigin getOrigin()
        Return the element type properties for this properties object. These values are set up by the metadata repository and define details of the metadata entity used to represent this element.
        Returns:
        AssetElementOrigin origin information.
      • getVersions

        public ElementVersions getVersions()
        Return the element version properties for this properties object. These values are set up by the metadata repository and define details of the metadata entity used to represent this element.
        Returns:
        ElementVersions version information.
      • getGUID

        public java.lang.String getGUID()
        Return the unique id for the properties object. Null means that no guid is assigned.
        Returns:
        String unique id
      • getStatus

        public ElementStatus getStatus()
        Return the status of the element.
        Returns:
        status enum
      • getURL

        public java.lang.String getURL()
        Returns the URL to access the properties object in the metadata repository. If no url is available then null is returned.
        Returns:
        String URL
      • getClassifications

        public java.util.List<ElementClassification> getClassifications()
        Return the list of classifications associated with the asset.
        Returns:
        Classifications list of classifications
      • getExtendedProperties

        public java.util.Map<java.lang.String,​java.lang.Object> getExtendedProperties()
        Return any properties defined for a subtype that are not explicitly supported by the connected asset API.
        Returns:
        property map
      • 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 AssetPropertyElementBase
        Parameters:
        objectToCompare - supplied object
        Returns:
        boolean result of comparison