Class ElementControlHeader

    • Constructor Detail

      • ElementControlHeader

        public ElementControlHeader()
        Default constructor
      • ElementControlHeader

        public ElementControlHeader​(ElementControlHeader template)
        Copy/clone constructor
        Parameters:
        template - type to clone
    • Method Detail

      • setElementSourceServer

        public void setElementSourceServer​(String elementSourceServer)
        Set up the URL of the server where the element was retrieved from. Typically this is a server where the OMAS interfaces are activated. If no URL is known for the server then null is returned.
        Parameters:
        elementSourceServer - URL of the server
      • getElementSourceServer

        public String getElementSourceServer()
        Return the URL of the server where the element was retrieved from. Typically this is a server where the OMAS interfaces are activated. If no URL is known for the server then null is returned.
        Returns:
        elementSourceServerURL the url of the server where the element came from
      • setElementOrigin

        public void setElementOrigin​(ElementOrigin elementOrigin)
        Set up the category of this element's origin.
        Parameters:
        elementOrigin - see ElementOrigin enum
      • getElementOrigin

        public ElementOrigin getElementOrigin()
        Return the origin category of the metadata element.
        Returns:
        ElementOrigin enum
      • getElementMetadataCollectionId

        public String getElementMetadataCollectionId()
        Returns the unique identifier for the metadata collection that is managed by the repository where the element originates (its home repository).
        Returns:
        String metadata collection id
      • setElementMetadataCollectionId

        public void setElementMetadataCollectionId​(String elementMetadataCollectionId)
        Set up the unique identifier for the metadata collection that is managed by the repository where the element originates (its home repository).
        Parameters:
        elementMetadataCollectionId - String unique identifier for the home metadata repository
      • getElementMetadataCollectionName

        public String getElementMetadataCollectionName()
        Return the name of the metadata collection that this element belongs to.
        Returns:
        name string
      • setElementMetadataCollectionName

        public void setElementMetadataCollectionName​(String elementMetadataCollectionName)
        Set up the name of the metadata collection that this asset belongs to.
        Parameters:
        elementMetadataCollectionName - name string
      • getElementLicense

        public String getElementLicense()
        Return the license associated with this metadata element (null means none).
        Returns:
        string license name
      • setElementLicense

        public void setElementLicense​(String elementLicense)
        Set up the license associated with this metadata element (null means none)
        Parameters:
        elementLicense - string license name
      • getStatus

        public ElementStatus getStatus()
        Return the status of this instance.
        Returns:
        InstanceStatus
      • setStatus

        public void setStatus​(ElementStatus newStatus)
        Set up the status of this instance.
        Parameters:
        newStatus - InstanceStatus
      • getElementCreatedBy

        public String getElementCreatedBy()
        Return the name of the user that created this instance.
        Returns:
        String user name
      • setElementCreatedBy

        public void setElementCreatedBy​(String elementCreatedBy)
        Set up the name of the user that created this instance.
        Parameters:
        elementCreatedBy - String user name
      • getElementUpdatedBy

        public String getElementUpdatedBy()
        Return the name of the user that last updated this instance.
        Returns:
        String user name
      • setElementUpdatedBy

        public void setElementUpdatedBy​(String elementUpdatedBy)
        Set up the name of the user that last updated this instance.
        Parameters:
        elementUpdatedBy - String user name
      • getElementMaintainedBy

        public List<String> getElementMaintainedBy()
        Return the list of users responsible for maintaining this instance.
        Returns:
        list of user identifiers
      • setElementMaintainedBy

        public void setElementMaintainedBy​(List<String> elementMaintainedBy)
        Set up the list of users responsible for maintaining this instance.
        Parameters:
        elementMaintainedBy - list of user identifiers
      • getElementCreateTime

        public Date getElementCreateTime()
        Return the date/time that this instance was created.
        Returns:
        Date/Time of creation
      • setElementCreateTime

        public void setElementCreateTime​(Date elementCreateTime)
        Set up the time that this instance was created.
        Parameters:
        elementCreateTime - Date/Time of creation
      • getElementUpdateTime

        public Date getElementUpdateTime()
        Return what was the late time this instance was updated.
        Returns:
        Date/Time last updated
      • setElementUpdateTime

        public void setElementUpdateTime​(Date elementUpdateTime)
        Set up the last update time for this instance.
        Parameters:
        elementUpdateTime - Date/Time last updated
      • getElementVersion

        public long getElementVersion()
        Return the version number for this instance.
        Returns:
        Long version number
      • setElementVersion

        public void setElementVersion​(long elementVersion)
        Set up the version number for this instance.
        Parameters:
        elementVersion - Long version number
      • getMappingProperties

        public Map<String,​Serializable> getMappingProperties()
        Return the additional properties used by the master repository to map to stored instances.
        Returns:
        property map
      • setMappingProperties

        public void setMappingProperties​(Map<String,​Serializable> mappingProperties)
        Set up the additional properties used by the master repository to map to stored instances.
        Parameters:
        mappingProperties - property map
      • 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 PropertyBase
        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 PropertyBase
        Returns:
        int hash code