Interface CMSMediaContainerService

All Known Implementing Classes:
DefaultCMSMediaContainerService

public interface CMSMediaContainerService
Service layer to manage media containers.
  • Method Details

    • getMediaContainerForQualifier

      MediaContainerModel getMediaContainerForQualifier(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:
      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(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.