Package de.hybris.platform.cmsfacades.mediacontainers.impl

Class DefaultMediaContainerFacade

java.lang.Object

de.hybris.platform.cmsfacades.mediacontainers.impl.DefaultMediaContainerFacade

All Implemented Interfaces:

MediaContainerFacade

public class DefaultMediaContainerFacade
extends java.lang.Object
implements MediaContainerFacade

Default implementation of the MediaContainerFacade interface

Field Summary

Fields

Modifier and Type	Field	Description
protected static java.lang.String	MEDIA_CONTAINER_QUALIFIER

Constructor Summary

Constructors

Constructor	Description
DefaultMediaContainerFacade()

Method Summary

Modifier and Type	Method	Description
protected MediaContainerData	converModelToData(MediaContainerModel model)	Converts the media container model to the associated data representation
MediaContainerModel	createMediaContainer()	Creates a new Media Container with a sequential qualifier name.
MediaContainerModel	createMediaContainer(java.lang.String qualifier)	Creates a new Media Container with the given qualifier name.
SearchResult<MediaContainerData>	findMediaContainers(java.lang.String text, PageableData pageableData)	Finds media containers using a free-text form.
protected java.lang.String	generateMediaContainerQualifier()	Builds a unique media container qualifier
protected CMSAdminSiteService	getCmsAdminSiteService()
protected CMSMediaContainerService	getCmsMediaContainerService()
protected java.util.List<java.lang.String>	getCmsRequiredMediaFormatQualifiers()
MediaContainerData	getMediaContainerForQualifier(java.lang.String qualifier)	Gets a single media container.
protected java.lang.String	getMediaForRequiredFormat(java.util.Collection<MediaModel> medias)	Provides the media URL for the defined required format.
protected PersistentKeyGenerator	getMediaQualifierIdGenerator()
protected PermissionCRUDService	getPermissionCRUDService()
protected UniqueItemIdentifierService	getUniqueItemIdentifierService()
void	setCmsAdminSiteService(CMSAdminSiteService cmsAdminSiteService)
void	setCmsMediaContainerService(CMSMediaContainerService cmsMediaContainerService)
void	setCmsRequiredMediaFormatQualifiers(java.util.List<java.lang.String> cmsRequiredMediaFormatQualifiers)
void	setMediaQualifierIdGenerator(PersistentKeyGenerator mediaQualifierIdGenerator)
void	setPermissionCRUDService(PermissionCRUDService permissionCRUDService)
void	setUniqueItemIdentifierService(UniqueItemIdentifierService uniqueItemIdentifierService)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MEDIA_CONTAINER_QUALIFIER

protected static final java.lang.String MEDIA_CONTAINER_QUALIFIER

See Also:

Constant Field Values

Constructor Detail

DefaultMediaContainerFacade

public DefaultMediaContainerFacade()

Method Detail

createMediaContainer

public MediaContainerModel createMediaContainer()

Description copied from interface: MediaContainerFacade

Creates a new Media Container with a sequential qualifier name.

Specified by:

createMediaContainer in interface MediaContainerFacade

Returns:

a new MediaContainerModel

createMediaContainer

public MediaContainerModel createMediaContainer(java.lang.String qualifier)

Description copied from interface: MediaContainerFacade

Creates a new Media Container with the given qualifier name.

Specified by:

createMediaContainer in interface MediaContainerFacade

Returns:

a new MediaContainerModel

getMediaContainerForQualifier

public MediaContainerData getMediaContainerForQualifier(java.lang.String qualifier)
                                                 throws CMSItemNotFoundException

Description copied from interface: MediaContainerFacade

Gets a single media container.

Specified by:

getMediaContainerForQualifier in interface MediaContainerFacade

Parameters:

qualifier - - the identifier of the media container to retrieve

Returns:

media container

Throws:

CMSItemNotFoundException - when the media container could not be found

findMediaContainers

public SearchResult<MediaContainerData> findMediaContainers(java.lang.String text,
                                                            PageableData pageableData)

Description copied from interface: MediaContainerFacade

Finds media containers using a free-text form. It also supports pagination.

Specified by:

findMediaContainers in interface MediaContainerFacade

Parameters:

text - The free-text string to be used on the media container search

pageableData - the pagination object

Returns:

the search result object.

converModelToData

protected MediaContainerData converModelToData(MediaContainerModel model)

Converts the media container model to the associated data representation

Parameters:

model - MediaContainerModel to be converted

Returns:

the MediaContainerData representation of the given model

getMediaForRequiredFormat

protected java.lang.String getMediaForRequiredFormat(java.util.Collection<MediaModel> medias)

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 NULL is returned.

Parameters:

medias -

Returns:

the media URL for the required media format; can be NULL

generateMediaContainerQualifier

protected java.lang.String generateMediaContainerQualifier()

Builds a unique media container qualifier

Returns:

the new qualifier

getMediaQualifierIdGenerator

protected PersistentKeyGenerator getMediaQualifierIdGenerator()

setMediaQualifierIdGenerator

public void setMediaQualifierIdGenerator(PersistentKeyGenerator mediaQualifierIdGenerator)

getCmsAdminSiteService

protected CMSAdminSiteService getCmsAdminSiteService()

setCmsAdminSiteService

public void setCmsAdminSiteService(CMSAdminSiteService cmsAdminSiteService)

getPermissionCRUDService

protected PermissionCRUDService getPermissionCRUDService()

setPermissionCRUDService

public void setPermissionCRUDService(PermissionCRUDService permissionCRUDService)

getCmsMediaContainerService

protected CMSMediaContainerService getCmsMediaContainerService()

setCmsMediaContainerService

public void setCmsMediaContainerService(CMSMediaContainerService cmsMediaContainerService)

getUniqueItemIdentifierService

protected UniqueItemIdentifierService getUniqueItemIdentifierService()

setUniqueItemIdentifierService

public void setUniqueItemIdentifierService(UniqueItemIdentifierService uniqueItemIdentifierService)

getCmsRequiredMediaFormatQualifiers

protected java.util.List<java.lang.String> getCmsRequiredMediaFormatQualifiers()

setCmsRequiredMediaFormatQualifiers

public void setCmsRequiredMediaFormatQualifiers(java.util.List<java.lang.String> cmsRequiredMediaFormatQualifiers)