Class MediaAsset

  • All Implemented Interfaces:
    GetContext, GetIdentifier, GetSequence, EntityData, PersistentData, java.io.Serializable

    @Entity
    public class MediaAsset
    extends java.lang.Object
    implements java.io.Serializable, GetIdentifier, GetContext, GetSequence, EntityData, PersistentData

    Object of entity type MediaAsset, e.g. images.

    An image can have more than one file for different resolutions (HighRes, LowRes) and formats (JPEG, EPS, etc) these are stored in the Media Object List.

    Since:
    4.0.0, 4.0.5 origin attribute supported, names for mediaObject and text are used in singular, added JPA annotations, getLanguage(), getCountry(), getMediaObjectsCount() and getMetadataCount() are deprecated
    See Also:
    Serialized Form
    • Method Detail

      • getVersion

        public java.lang.String getVersion()
        Version string from the content system
        Returns:
        version string or null if not set
      • setVersion

        public void setVersion​(java.lang.String version)
        Parameters:
        version - see getVersion()
      • getTimestamp

        public java.lang.String getTimestamp()
        Get timestamp from the content system.

        Timestamp is used as a string to support differing types of timestamp representation as used by different content system. publishing server does not validate any format of this string.

        Returns:
        timestamp string
      • setTimestamp

        public void setTimestamp​(java.lang.String timestamp)
        Parameters:
        timestamp - see getTimestamp()
      • getLabel

        public java.lang.String getLabel()
        Display label for the asset.
        Returns:
        label or null if not set
      • setLabel

        public void setLabel​(java.lang.String label)
        Parameters:
        label - see getLabel()
      • getTemplate

        public java.lang.String getTemplate()
        Returns:
        String identifier of the template to render this content.
      • setTemplate

        public void setTemplate​(java.lang.String template)
        Parameters:
        template - getTemplate()
      • getSequence

        public int getSequence()
        Get sequence number for the asset as given in the content system.

        This should reflect the position of the current asset in the sorting of assets of its bucket.

        Specified by:
        getSequence in interface GetSequence
        Returns:
        ordered position within a list sequenceable objects
      • setSequence

        public void setSequence​(int sequence)
        Parameters:
        sequence - see getSequence()
      • getBucket

        public Bucket getBucket()
        Returns:
        Parent bucket that this price is related to.
      • getTexts

        public java.util.List<Text> getTexts()
        Returns:
        List of text (e.g. image sub line).

        List is LAZY loaded.

      • setTexts

        public void setTexts​(java.util.List<Text> texts)
        Parameters:
        texts - getTexts()
      • getMediaObjects

        public java.util.List<MediaObject> getMediaObjects()
        Returns:
        List of media object like image files in different formats and resolutions.

        List is LAZY loaded.

      • getMetaData

        public java.util.List<KeyValue> getMetaData()
        Returns:
        List of meta data related to the bucket or empty list.

        List is LAZY loaded.

      • setMetaData

        public void setMetaData​(java.util.List<KeyValue> metaData)
        Parameters:
        metaData - see getMetaData()
      • getGroupIdentifier

        public java.lang.String getGroupIdentifier()
        String key for grouping texts of the same type.
        Returns:
        group identifier string or null if not set
      • setGroupIdentifier

        public void setGroupIdentifier​(java.lang.String groupIdentifier)
        Parameters:
        groupIdentifier - see getGroupIdentifier()
      • getConnectorEntity

        public ConnectorEntity getConnectorEntity()
        Returns:
        connector entity object or null if not set
      • getEntityMediaAssetId

        public java.lang.String getEntityMediaAssetId()
        Returns:
        Identifier of related entity in entity model.
      • setEntityMediaAssetId

        public void setEntityMediaAssetId​(java.lang.String entityMediaAssetId)
        Sets entityMediaAssetId and eventually removes current entityMediaAsset if it does not match the id
        Parameters:
        entityMediaAssetId - getEntityMediaAssetId()
      • setBucketId

        public void setBucketId​(java.lang.String bucketId)
        Sets bucketId and eventually removes current bucket if it does not match the id
        Parameters:
        bucketId - getBucketId()
      • getCreatedBy

        public java.lang.String getCreatedBy()
        Returns:
        creation user or null if not set
      • setCreatedBy

        public void setCreatedBy​(java.lang.String createdBy)
        Parameters:
        createdBy - see getCreatedBy()
      • getCreatedOn

        public java.util.Date getCreatedOn()
        Returns:
        creation date or null if not set
      • setCreatedOn

        public void setCreatedOn​(java.util.Date createdOn)
        Parameters:
        createdOn - see getCreatedOn()
      • getUpdatedBy

        public java.lang.String getUpdatedBy()
        Returns:
        last modified user or null if not set
      • setUpdatedBy

        public void setUpdatedBy​(java.lang.String updatedBy)
        Parameters:
        updatedBy - see getUpdatedBy()
      • getUpdatedOn

        public java.util.Date getUpdatedOn()
        Returns:
        last modified date or null if not set
      • setUpdatedOn

        public void setUpdatedOn​(java.util.Date updatedOn)
        Parameters:
        updatedOn - see getUpdatedOn()
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
      • getOrigin

        public java.lang.String getOrigin()
        Returns:
        Origin of data entity object, e.g. name of the source system. This property is filled by the connector. Might return null.
      • setOrigin

        public void setOrigin​(java.lang.String origin)
        Parameters:
        origin - getOrigin()
      • getEntityIdentifier

        public java.lang.String getEntityIdentifier()
        Description copied from interface: EntityData
        Identifier of an entity in the entity model where the current object refers to.
        Specified by:
        getEntityIdentifier in interface EntityData
        Returns:
        entity identifier as string
      • setEntityIdentifier

        public void setEntityIdentifier​(java.lang.String entityIdentifier)
        Description copied from interface: EntityData
        Identifier of an entity in the entity model where the current object refers to.
        Specified by:
        setEntityIdentifier in interface EntityData
      • getContentMetaData

        public java.util.List<ContentMetaData> getContentMetaData()
        Returns:
        List of ContentMetaData related to MediaAsset.

        List is not loaded by Entity Manager in its standard methods. Use specific Entity Manager methods for loading.