Class DefaultMediaContainerFacade
java.lang.Object
de.hybris.platform.cmsfacades.mediacontainers.impl.DefaultMediaContainerFacade
- All Implemented Interfaces:
MediaContainerFacade
Default implementation of the
MediaContainerFacade interface-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected MediaContainerDataConverts the media container model to the associated data representationCreates a new Media Container with a sequential qualifier name.createMediaContainer(String qualifier) Creates a new Media Container with the given qualifier name.findMediaContainers(String text, PageableData pageableData) Finds media containers using a free-text form.protected StringBuilds a unique media container qualifierprotected CMSAdminSiteServiceprotected CMSMediaContainerServicegetMediaContainerForQualifier(String qualifier) Gets a single media container.protected StringProvides the media URL for the defined required format.protected PersistentKeyGeneratorprotected PermissionCRUDServiceprotected UniqueItemIdentifierServicevoidsetCmsAdminSiteService(CMSAdminSiteService cmsAdminSiteService) voidsetCmsMediaContainerService(CMSMediaContainerService cmsMediaContainerService) voidsetCmsRequiredMediaFormatQualifiers(List<String> cmsRequiredMediaFormatQualifiers) voidsetMediaQualifierIdGenerator(PersistentKeyGenerator mediaQualifierIdGenerator) voidsetPermissionCRUDService(PermissionCRUDService permissionCRUDService) voidsetUniqueItemIdentifierService(UniqueItemIdentifierService uniqueItemIdentifierService)
-
Field Details
-
MEDIA_CONTAINER_QUALIFIER
- See Also:
-
-
Constructor Details
-
DefaultMediaContainerFacade
public DefaultMediaContainerFacade()
-
-
Method Details
-
createMediaContainer
Description copied from interface:MediaContainerFacadeCreates a new Media Container with a sequential qualifier name.- Specified by:
createMediaContainerin interfaceMediaContainerFacade- Returns:
- a new
MediaContainerModel
-
createMediaContainer
Description copied from interface:MediaContainerFacadeCreates a new Media Container with the given qualifier name.- Specified by:
createMediaContainerin interfaceMediaContainerFacade- Parameters:
qualifier- -qualifier name- Returns:
- a new
MediaContainerModel
-
getMediaContainerForQualifier
public MediaContainerData getMediaContainerForQualifier(String qualifier) throws CMSItemNotFoundException Description copied from interface:MediaContainerFacadeGets a single media container.- Specified by:
getMediaContainerForQualifierin interfaceMediaContainerFacade- Parameters:
qualifier- - the identifier of the media container to retrieve- Returns:
- media container
- Throws:
CMSItemNotFoundException- when the media container could not be found
-
findMediaContainers
Description copied from interface:MediaContainerFacadeFinds media containers using a free-text form. It also supports pagination.- Specified by:
findMediaContainersin interfaceMediaContainerFacade- Parameters:
text- The free-text string to be used on the media container searchpageableData- the pagination object- Returns:
- the search result object.
-
converModelToData
Converts the media container model to the associated data representation- Parameters:
model-MediaContainerModelto be converted- Returns:
- the
MediaContainerDatarepresentation of the given model
-
getMediaForRequiredFormat
Provides the media URL for the defined required format.- When no required format is defined, then the first media URL found is returned.
- When no media is found for the required media format, then
NULLis returned.- Parameters:
medias-- Returns:
- the media URL for the required media format; can be
NULL
-
generateMediaContainerQualifier
Builds a unique media container qualifier- Returns:
- the new qualifier
-
getMediaQualifierIdGenerator
-
setMediaQualifierIdGenerator
-
getCmsAdminSiteService
-
setCmsAdminSiteService
-
getPermissionCRUDService
-
setPermissionCRUDService
-
getCmsMediaContainerService
-
setCmsMediaContainerService
-
getUniqueItemIdentifierService
-
setUniqueItemIdentifierService
-
getCmsRequiredMediaFormatQualifiers
-
setCmsRequiredMediaFormatQualifiers
-