Package de.hybris.platform.core.model.media

Class MediaModel

java.lang.Object
de.hybris.platform.servicelayer.model.AbstractItemModel
de.hybris.platform.core.model.ItemModel
de.hybris.platform.core.model.media.AbstractMediaModel
de.hybris.platform.core.model.media.MediaModel
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
BarcodeMediaModel, CatalogUnawareMediaModel, CatalogVersionSyncScheduleMediaModel, ConfigurationMediaModel, DocumentModel, EmailAttachmentModel, FormatterModel, ImpExMediaModel, JasperMediaModel, JobMediaModel, LDIFMediaModel, LogFileModel
public class MediaModel extends AbstractMediaModel
Generated model class for type Media first defined at extension core.
See Also:

  • Field Details

    • _TYPECODE

      public static final String _TYPECODE
      Generated model type code constant.
      See Also:

    • _MEDIACONTAINER2MEDIAREL

      public static final String _MEDIACONTAINER2MEDIAREL
      Generated relation code constant for relation MediaContainer2MediaRel defining source attribute mediaContainer in extension core.
      See Also:

    • _CATEGORYMEDIARELATION

      public static final String _CATEGORYMEDIARELATION
      Generated relation code constant for relation CategoryMediaRelation defining source attribute supercategories in extension catalog.
      See Also:

    • _CONVERTEDMEDIASRELATION

      public static final String _CONVERTEDMEDIASRELATION
      Generated relation code constant for relation ConvertedMediasRelation defining source attribute original in extension mediaconversion.
      See Also:

    • CODE

      public static final String CODE
      Generated constant - Attribute key of Media.code attribute defined at extension core.
      See Also:

    • INTERNALURL

      public static final String INTERNALURL
      Generated constant - Attribute key of Media.internalURL attribute defined at extension core.
      See Also:

    • URL

      public static final String URL
      Generated constant - Attribute key of Media.URL attribute defined at extension core.
      See Also:

    • URL2

      public static final String URL2
      Generated constant - Attribute key of Media.URL2 attribute defined at extension core.
      See Also:

    • DOWNLOADURL

      public static final String DOWNLOADURL
      Generated constant - Attribute key of Media.downloadURL attribute defined at extension core.
      See Also:

    • DESCRIPTION

      public static final String DESCRIPTION
      Generated constant - Attribute key of Media.description attribute defined at extension core.
      See Also:

    • ALTTEXT

      public static final String ALTTEXT
      Generated constant - Attribute key of Media.altText attribute defined at extension core.
      See Also:

    • REMOVABLE

      public static final String REMOVABLE
      Generated constant - Attribute key of Media.removable attribute defined at extension core.
      See Also:

    • MEDIAFORMAT

      public static final String MEDIAFORMAT
      Generated constant - Attribute key of Media.mediaFormat attribute defined at extension core.
      See Also:

    • FOLDER

      public static final String FOLDER
      Generated constant - Attribute key of Media.folder attribute defined at extension core.
      See Also:

    • SUBFOLDERPATH

      public static final String SUBFOLDERPATH
      Generated constant - Attribute key of Media.subFolderPath attribute defined at extension core.
      See Also:

    • FOREIGNDATAOWNERS

      public static final String FOREIGNDATAOWNERS
      Generated constant - Attribute key of Media.foreignDataOwners attribute defined at extension core.
      See Also:

    • PERMITTEDPRINCIPALS

      public static final String PERMITTEDPRINCIPALS
      Generated constant - Attribute key of Media.permittedPrincipals attribute defined at extension core.
      See Also:

    • DENIEDPRINCIPALS

      public static final String DENIEDPRINCIPALS
      Generated constant - Attribute key of Media.deniedPrincipals attribute defined at extension core.
      See Also:

    • MEDIACONTAINER

      public static final String MEDIACONTAINER
      Generated constant - Attribute key of Media.mediaContainer attribute defined at extension core.
      See Also:

    • DERIVEDMEDIAS

      public static final String DERIVEDMEDIAS
      Generated constant - Attribute key of Media.derivedMedias attribute defined at extension core.
      See Also:

    • CATALOG

      public static final String CATALOG
      Generated constant - Attribute key of Media.catalog attribute defined at extension catalog.
      See Also:

    • CATALOGVERSION

      public static final String CATALOGVERSION
      Generated constant - Attribute key of Media.catalogVersion attribute defined at extension catalog.
      See Also:

    • SUPERCATEGORIES

      public static final String SUPERCATEGORIES
      Generated constant - Attribute key of Media.supercategories attribute defined at extension catalog.
      See Also:

    • METADATADATAPK

      public static final String METADATADATAPK
      Generated constant - Attribute key of Media.metaDataDataPK attribute defined at extension mediaconversion.
      See Also:

    • ORIGINALDATAPK

      public static final String ORIGINALDATAPK
      Generated constant - Attribute key of Media.originalDataPK attribute defined at extension mediaconversion.
      See Also:

    • ORIGINAL

      public static final String ORIGINAL
      Generated constant - Attribute key of Media.original attribute defined at extension mediaconversion.
      See Also:

    • CONVERTEDMEDIAS

      public static final String CONVERTEDMEDIAS
      Generated constant - Attribute key of Media.convertedMedias attribute defined at extension mediaconversion.
      See Also:

    • METADATA

      public static final String METADATA
      Generated constant - Attribute key of Media.metaData attribute defined at extension mediaconversion.
      See Also:

  • Constructor Details

    • MediaModel

      public MediaModel()
      Generated constructor - Default constructor for generic creation.

    • MediaModel

      public MediaModel(ItemModelContext ctx)
      Generated constructor - Default constructor for creation with existing context
      Parameters:
      ctx - the model context to be injected, must not be null

    • MediaModel

      @Deprecated(since="4.1.1", forRemoval=true) public MediaModel(CatalogVersionModel _catalogVersion, String _code)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 4.1.1 Please use the default constructor without parameters
      Generated constructor - Constructor with all mandatory attributes.
      Parameters:
      _catalogVersion - initial attribute declared by type Media at extension catalog
      _code - initial attribute declared by type Media at extension core

    • MediaModel

      @Deprecated(since="4.1.1", forRemoval=true) public MediaModel(CatalogVersionModel _catalogVersion, String _code, ItemModel _owner)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 4.1.1 Please use the default constructor without parameters
      Generated constructor - for all mandatory and initial attributes.
      Parameters:
      _catalogVersion - initial attribute declared by type Media at extension catalog
      _code - initial attribute declared by type Media at extension core
      _owner - initial attribute declared by type Item at extension core

  • Method Details

    • getAlttext

      @Deprecated(since="ages", forRemoval=true) public String getAlttext()
      Deprecated, for removal: This API element is subject to removal in a future version.
      since ages - use { @link #getAltText()} instead
      Generated method - Getter of the Media.altText attribute defined at extension core.
      Returns:
      the altText

    • getAltText

      @Accessor(qualifier="altText", type=GETTER) public String getAltText()
      Generated method - Getter of the Media.altText attribute defined at extension core.
      Returns:
      the altText

    • getCatalogVersion

      @Accessor(qualifier="catalogVersion", type=GETTER) public CatalogVersionModel getCatalogVersion()
      Generated method - Getter of the Media.catalogVersion attribute defined at extension catalog.
      Returns:
      the catalogVersion

    • getCode

      @Accessor(qualifier="code", type=GETTER) public String getCode()
      Generated method - Getter of the Media.code attribute defined at extension core.
      Returns:
      the code - Code of media

    • getConvertedMedias

      @Accessor(qualifier="convertedMedias", type=GETTER) public Collection<MediaModel> getConvertedMedias()
      Generated method - Getter of the Media.convertedMedias attribute defined at extension mediaconversion. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
      Returns:
      the convertedMedias - Medias (in other formats) which were converted from this media.

    • getDeniedPrincipals

      @Accessor(qualifier="deniedPrincipals", type=GETTER) public Collection<PrincipalModel> getDeniedPrincipals()
      Generated method - Getter of the Media.deniedPrincipals dynamic attribute defined at extension core. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
      Returns:
      the deniedPrincipals

    • getDerivedMedias

      @Accessor(qualifier="derivedMedias", type=GETTER) public Collection<DerivedMediaModel> getDerivedMedias()
      Generated method - Getter of the Media.derivedMedias attribute defined at extension core. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
      Returns:
      the derivedMedias

    • getDescription

      @Accessor(qualifier="description", type=GETTER) public String getDescription()
      Generated method - Getter of the Media.description attribute defined at extension core.
      Returns:
      the description

    • getDownloadurl

      @Deprecated(since="ages", forRemoval=true) public String getDownloadurl()
      Deprecated, for removal: This API element is subject to removal in a future version.
      since ages - use { @link #getDownloadURL()} instead
      Generated method - Getter of the Media.downloadURL dynamic attribute defined at extension core.
      Returns:
      the downloadURL

    • getDownloadURL

      @Accessor(qualifier="downloadURL", type=GETTER) public String getDownloadURL()
      Generated method - Getter of the Media.downloadURL dynamic attribute defined at extension core.
      Returns:
      the downloadURL

    • getFolder

      @Accessor(qualifier="folder", type=GETTER) public MediaFolderModel getFolder()
      Generated method - Getter of the Media.folder attribute defined at extension core.
      Returns:
      the folder - Sub folder where this media is stored.

    • getForeignDataOwners

      @Accessor(qualifier="foreignDataOwners", type=GETTER) public Collection<MediaModel> getForeignDataOwners()
      Generated method - Getter of the Media.foreignDataOwners dynamic attribute defined at extension core. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
      Returns:
      the foreignDataOwners - List of all medias referencing same data file.

    • getInternalURL

      @Accessor(qualifier="internalURL", type=GETTER) public String getInternalURL()
      Generated method - Getter of the Media.internalURL attribute defined at extension core.
      Returns:
      the internalURL

    • getMediaContainer

      @Accessor(qualifier="mediaContainer", type=GETTER) public MediaContainerModel getMediaContainer()
      Generated method - Getter of the Media.mediaContainer attribute defined at extension core.
      Returns:
      the mediaContainer

    • getMediaFormat

      @Accessor(qualifier="mediaFormat", type=GETTER) public MediaFormatModel getMediaFormat()
      Generated method - Getter of the Media.mediaFormat attribute defined at extension core.
      Returns:
      the mediaFormat - Format of this media

    • getMetaData

      @Accessor(qualifier="metaData", type=GETTER) public Collection<MediaMetaDataModel> getMetaData()
      Generated method - Getter of the Media.metaData attribute defined at extension mediaconversion. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
      Returns:
      the metaData - Meta data information for the media, which has been persisted to database.

    • getMetaDataDataPK

      @Accessor(qualifier="metaDataDataPK", type=GETTER) public Long getMetaDataDataPK()
      Generated method - Getter of the Media.metaDataDataPK attribute defined at extension mediaconversion.
      Returns:
      the metaDataDataPK - The data pk from which the meta data was extracted from.

    • getOriginal

      @Accessor(qualifier="original", type=GETTER) public MediaModel getOriginal()
      Generated method - Getter of the Media.original attribute defined at extension mediaconversion.
      Returns:
      the original - The parent media this media was converted from.

    • getOriginalDataPK

      @Accessor(qualifier="originalDataPK", type=GETTER) public Long getOriginalDataPK()
      Generated method - Getter of the Media.originalDataPK attribute defined at extension mediaconversion.
      Returns:
      the originalDataPK - The data pk from which this media was converted from.

    • getPermittedPrincipals

      @Accessor(qualifier="permittedPrincipals", type=GETTER) public Collection<PrincipalModel> getPermittedPrincipals()
      Generated method - Getter of the Media.permittedPrincipals dynamic attribute defined at extension core. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
      Returns:
      the permittedPrincipals

    • getRemovable

      @Accessor(qualifier="removable", type=GETTER) public Boolean getRemovable()
      Generated method - Getter of the Media.removable attribute defined at extension core.
      Returns:
      the removable

    • getSubFolderPath

      @Accessor(qualifier="subFolderPath", type=GETTER) public String getSubFolderPath()
      Generated method - Getter of the Media.subFolderPath attribute defined at extension core.
      Returns:
      the subFolderPath - Generated location (by one of Storage Strategies) to media within storage.

    • getSupercategories

      @Accessor(qualifier="supercategories", type=GETTER) public Collection<CategoryModel> getSupercategories()
      Generated method - Getter of the Media.supercategories attribute defined at extension catalog. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
      Returns:
      the supercategories - Super Categories

    • getUrl

      @Deprecated(since="ages", forRemoval=true) public String getUrl()
      Deprecated, for removal: This API element is subject to removal in a future version.
      since ages - use { @link #getURL()} instead
      Generated method - Getter of the Media.URL dynamic attribute defined at extension core.
      Returns:
      the URL

    • getURL

      @Accessor(qualifier="URL", type=GETTER) public String getURL()
      Generated method - Getter of the Media.URL dynamic attribute defined at extension core.
      Returns:
      the URL

    • getUrl2

      @Deprecated(since="ages", forRemoval=true) public String getUrl2()
      Deprecated, for removal: This API element is subject to removal in a future version.
      since ages - use { @link #getURL2()} instead
      Generated method - Getter of the Media.URL2 attribute defined at extension core.
      Returns:
      the URL2

    • getURL2

      @Accessor(qualifier="URL2", type=GETTER) public String getURL2()
      Generated method - Getter of the Media.URL2 attribute defined at extension core.
      Returns:
      the URL2

    • setAlttext

      @Deprecated(since="ages", forRemoval=true) public void setAlttext(String value)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since ages - use { @link #setAltText(java.lang.String)} instead
      Generated method - Setter of Media.altText attribute defined at extension core.
      Parameters:
      value - the altText

    • setAltText

      @Accessor(qualifier="altText", type=SETTER) public void setAltText(String value)
      Generated method - Setter of Media.altText attribute defined at extension core.
      Parameters:
      value - the altText

    • setCatalogVersion

      @Accessor(qualifier="catalogVersion", type=SETTER) public void setCatalogVersion(CatalogVersionModel value)
      Generated method - Setter of Media.catalogVersion attribute defined at extension catalog.
      Parameters:
      value - the catalogVersion

    • setCode

      @Accessor(qualifier="code", type=SETTER) public void setCode(String value)
      Generated method - Setter of Media.code attribute defined at extension core.
      Parameters:
      value - the code - Code of media

    • setConvertedMedias

      @Accessor(qualifier="convertedMedias", type=SETTER) public void setConvertedMedias(Collection<MediaModel> value)
      Generated method - Setter of Media.convertedMedias attribute defined at extension mediaconversion.
      Parameters:
      value - the convertedMedias - Medias (in other formats) which were converted from this media.

    • setDeniedPrincipals

      @Accessor(qualifier="deniedPrincipals", type=SETTER) public void setDeniedPrincipals(Collection<PrincipalModel> value)
      Generated method - Setter of Media.deniedPrincipals dynamic attribute defined at extension core.
      Parameters:
      value - the deniedPrincipals

    • setDerivedMedias

      @Accessor(qualifier="derivedMedias", type=SETTER) public void setDerivedMedias(Collection<DerivedMediaModel> value)
      Generated method - Setter of Media.derivedMedias attribute defined at extension core.
      Parameters:
      value - the derivedMedias

    • setDescription

      @Accessor(qualifier="description", type=SETTER) public void setDescription(String value)
      Generated method - Setter of Media.description attribute defined at extension core.
      Parameters:
      value - the description

    • setFolder

      @Accessor(qualifier="folder", type=SETTER) public void setFolder(MediaFolderModel value)
      Generated method - Setter of Media.folder attribute defined at extension core.
      Parameters:
      value - the folder - Sub folder where this media is stored.

    • setInternalURL

      @Accessor(qualifier="internalURL", type=SETTER) public void setInternalURL(String value)
      Generated method - Setter of Media.internalURL attribute defined at extension core.
      Parameters:
      value - the internalURL

    • setMediaContainer

      @Accessor(qualifier="mediaContainer", type=SETTER) public void setMediaContainer(MediaContainerModel value)
      Generated method - Setter of Media.mediaContainer attribute defined at extension core.
      Parameters:
      value - the mediaContainer

    • setMediaFormat

      @Accessor(qualifier="mediaFormat", type=SETTER) public void setMediaFormat(MediaFormatModel value)
      Generated method - Setter of Media.mediaFormat attribute defined at extension core.
      Parameters:
      value - the mediaFormat - Format of this media

    • setMetaData

      @Accessor(qualifier="metaData", type=SETTER) public void setMetaData(Collection<MediaMetaDataModel> value)
      Generated method - Setter of Media.metaData attribute defined at extension mediaconversion.
      Parameters:
      value - the metaData - Meta data information for the media, which has been persisted to database.

    • setMetaDataDataPK

      @Accessor(qualifier="metaDataDataPK", type=SETTER) public void setMetaDataDataPK(Long value)
      Generated method - Setter of Media.metaDataDataPK attribute defined at extension mediaconversion.
      Parameters:
      value - the metaDataDataPK - The data pk from which the meta data was extracted from.

    • setOriginal

      @Accessor(qualifier="original", type=SETTER) public void setOriginal(MediaModel value)
      Generated method - Setter of Media.original attribute defined at extension mediaconversion.
      Parameters:
      value - the original - The parent media this media was converted from.

    • setOriginalDataPK

      @Accessor(qualifier="originalDataPK", type=SETTER) public void setOriginalDataPK(Long value)
      Generated method - Setter of Media.originalDataPK attribute defined at extension mediaconversion.
      Parameters:
      value - the originalDataPK - The data pk from which this media was converted from.

    • setPermittedPrincipals

      @Accessor(qualifier="permittedPrincipals", type=SETTER) public void setPermittedPrincipals(Collection<PrincipalModel> value)
      Generated method - Setter of Media.permittedPrincipals dynamic attribute defined at extension core.
      Parameters:
      value - the permittedPrincipals

    • setRemovable

      @Accessor(qualifier="removable", type=SETTER) public void setRemovable(Boolean value)
      Generated method - Setter of Media.removable attribute defined at extension core.
      Parameters:
      value - the removable

    • setSubFolderPath

      @Accessor(qualifier="subFolderPath", type=SETTER) public void setSubFolderPath(String value)
      Generated method - Setter of Media.subFolderPath attribute defined at extension core.
      Parameters:
      value - the subFolderPath - Generated location (by one of Storage Strategies) to media within storage.

    • setSupercategories

      @Accessor(qualifier="supercategories", type=SETTER) public void setSupercategories(Collection<CategoryModel> value)
      Generated method - Setter of Media.supercategories attribute defined at extension catalog.
      Parameters:
      value - the supercategories - Super Categories

    • setUrl

      @Deprecated(since="ages", forRemoval=true) public void setUrl(String value)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since ages - use { @link #setURL(java.lang.String)} instead
      Generated method - Setter of Media.URL dynamic attribute defined at extension core.
      Parameters:
      value - the URL

    • setURL

      @Accessor(qualifier="URL", type=SETTER) public void setURL(String value)
      Generated method - Setter of Media.URL dynamic attribute defined at extension core.
      Parameters:
      value - the URL