Class MediaObject

    • Constructor Detail

      • MediaObject

        public MediaObject()
        Default constructor.
      • MediaObject

        public MediaObject​(java.lang.String identifier,
                           java.lang.String filename,
                           java.lang.String path,
                           java.lang.String type,
                           java.lang.String media)
        Creates a media object with necessary properties.
        Parameters:
        identifier - getIdentifier()
        filename - getFilename()
        path - getPath()
        type - getType()
        media - getMedia()
    • Method Detail

      • getId

        public int getId()
      • setId

        public void setId​(int id)
      • getGroupIdentifier

        public java.lang.String getGroupIdentifier()
        String key for grouping media objects 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

        @Deprecated
        public ConnectorEntity getConnectorEntity()
        Deprecated.
        MediaObject has no connector entity that can be set via ison.
        Returns:
        connector entity object or null if not set
      • setConnectorEntity

        @Deprecated
        public void setConnectorEntity​(ConnectorEntity connectorEntity)
        Deprecated.
        MediaObject has no connector entity that can be set via ison.
        Parameters:
        connectorEntity -
      • 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()
      • getFilename

        public java.lang.String getFilename()
        Returns:
        Name of the file (with extension).
      • setFilename

        public void setFilename​(java.lang.String filename)
        Parameters:
        filename - getFilename()
      • getPath

        public java.lang.String getPath()
        Returns:
        System path without filename.
      • setPath

        public void setPath​(java.lang.String path)
        Parameters:
        path - getPath()
      • getType

        public java.lang.String getType()
        Type like JPEG , EPS, etc.

        At the time being there is no fixed vocabulary on media object types.
        It is recommended practice to use types from the IANA MIME type registry.

        Returns:
        type
      • setType

        public void setType​(java.lang.String type)
        Parameters:
        type - getType()
      • getUrl

        public java.lang.String getUrl()
        Returns:
        URL to media asset system
      • setUrl

        public void setUrl​(java.lang.String url)
        Parameters:
        url - getUrl()
      • getMetaData

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

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

        public java.lang.String getMedia()
        Optional media content.
        Returns:
        content as string
      • setMedia

        public void setMedia​(java.lang.String media)
        Parameters:
        media - getMedia()
      • 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()
      • getMediaAsset

        public MediaAsset getMediaAsset()
      • setMediaAsset

        public void setMediaAsset​(MediaAsset mediaAsset)
      • toString

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

        public java.lang.String getFullpath()
        Returns:
        returns the full path of the media object concatenating path and filename
      • 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
      • setContext

        public void setContext​(Context context)
        Description copied from interface: EntityData
        set the context of entity data object
        Specified by:
        setContext in interface EntityData