Package de.hybris.platform.cmsfacades.media.service

Interface CMSMediaContainerService

All Known Implementing Classes:

DefaultCMSMediaContainerService

public interface CMSMediaContainerService

Service layer to manage media containers.

Method Summary

Modifier and Type	Method	Description
SearchResult<MediaContainerModel>	findMediaContainersForCatalogVersion(java.lang.String text, CatalogVersionModel catalogVersion, PageableData pageableData)	Finds media containers using a free-text form in a given catalog version.
MediaContainerModel	getMediaContainerForQualifier(java.lang.String qualifier, CatalogVersionModel catalogVersion)	Retrieve a single media container that has the specified qualifier value in a given catalog version.

Method Detail

getMediaContainerForQualifier

MediaContainerModel getMediaContainerForQualifier(java.lang.String qualifier,
                                                  CatalogVersionModel catalogVersion)

Retrieve a single media container that has the specified qualifier value in a given catalog version.

Parameters:

qualifier - the identifier of the media container to find

catalogVersion - the catalog version that is active in the session

Returns:

media container matching the specified qualifier

Throws:

java.lang.IllegalArgumentException - when qualifier is null

UnknownIdentifierException - when no media container is found for the specified qualifier

AmbiguousIdentifierException - when multiple media containers are found for the specified qualifier

findMediaContainersForCatalogVersion

SearchResult<MediaContainerModel> findMediaContainersForCatalogVersion(java.lang.String text,
                                                                       CatalogVersionModel catalogVersion,
                                                                       PageableData pageableData)

Finds media containers using a free-text form in a given catalog version. It also supports pagination.

Parameters:

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

catalogVersion - The catalog version that is active in the session

pageableData - the pagination object

Returns:

the search result object.