Package org.silverpeas.components.gallery.model

Class InternalMedia

  • All Implemented Interfaces:
    Serializable, org.silverpeas.core.contribution.contentcontainer.content.SilverContentInterface, org.silverpeas.core.contribution.model.Contribution, org.silverpeas.core.contribution.model.SilverpeasContent, org.silverpeas.core.contribution.model.WithPermanentLink, org.silverpeas.core.Identifiable, org.silverpeas.core.Instance<org.silverpeas.core.contribution.model.Contribution>, org.silverpeas.core.Nameable, org.silverpeas.core.security.Securable, org.silverpeas.core.SilverpeasResource
    Direct Known Subclasses:
    Photo, Sound, Video
    public abstract class InternalMedia
extends Media
    This class represents a Media that the content (the file in other words) is saved on the Silverpeas workspace.
    See Also:
    Serialized Form

    • Constructor Detail

      • InternalMedia

        public InternalMedia()

      • InternalMedia

        protected InternalMedia​(InternalMedia other)

    • Method Detail

      • isDownloadAuthorized

        public boolean isDownloadAuthorized()
        Indicates if the media is marked as downloadable. The visibility period is not taken into account here.
        Returns:
        true if marked as downloadable, false otherwise.

      • isDownloadable

        public boolean isDownloadable()
        Indicates if the download is possible according the visibility information. The date of day must be included into visibility period.
        Overrides:
        isDownloadable in class Media
        Returns:
        true if download is possible, false otherwise.

      • getFileName

        public String getFileName()

      • setFileName

        public void setFileName​(String fileName)

      • getFileSize

        public long getFileSize()

      • setFileSize

        public void setFileSize​(long fileSize)

      • setFileMimeType

        public void setFileMimeType​(MediaMimeType fileMimeType)

      • setDownloadAuthorized

        public void setDownloadAuthorized​(boolean downloadAuthorized)

      • getDownloadPeriod

        public org.silverpeas.core.date.period.Period getDownloadPeriod()

      • setDownloadPeriod

        public void setDownloadPeriod​(org.silverpeas.core.date.period.Period downloadPeriod)

      • getApplicationThumbnailUrl

        public String getApplicationThumbnailUrl​(MediaResolution mediaResolution)
        Description copied from class: Media
        Gets the Application URL thumbnail of the media according the specified media resolution.
        Overrides:
        getApplicationThumbnailUrl in class Media
        Parameters:
        mediaResolution - resolution of the media
        Returns:
        the URL of media thumbnail.

      • getFile

        public org.silverpeas.core.io.file.SilverpeasFile getFile​(MediaResolution mediaResolution,
                                                          String size)
        Description copied from class: Media
        Gets the Silverpeas file.
        Specified by:
        getFile in class Media
        Parameters:
        mediaResolution - the aimed resolution.
        size - a specific size applied on the aimed resolution, ignored if not defined.
        Returns:
        a SilverpeasFile instance which could represents also an non existing file.

      • addMetaData

        public void addMetaData​(MetaData data)
        Adds a metadata.
        Parameters:
        data - a metadata.

      • getMetaData

        public MetaData getMetaData​(String property)
        Gets a metadata according to the specified property name.
        Parameters:
        property - the property name for which the metadata is requested.
        Returns:
        the metadata if it exists, null otherwise.

      • getMetaDataProperties

        public Collection<String> getMetaDataProperties()
        Gets all metadata property names.
        Returns:
        the list of metadata property names, empty list if no metadata.