Package org.opencms.repository

Interface I_CmsRepository

All Superinterfaces:
I_CmsConfigurationParameterHandler
All Known Subinterfaces:
I_CmsCmisRepository
All Known Implementing Classes:
A_CmsCmisRepository, A_CmsRepository, CmsCmisRepository, CmsJlanRepository, CmsRepository
public interface I_CmsRepository extends I_CmsConfigurationParameterHandler
Represents a repository.

Since different types of repositories have very different methods, this interface only provides the bare minimum of methods which are necessary for configuration.

Since:
6.2.4

  • Method Details

    • getFilter

      CmsRepositoryFilter getFilter()
      Gets the repository filter.

      Returns:
      the repository filter

    • getName

      String getName()
      Returns the name of the repository.

      Returns:
      the name of the repository

    • getTranslation

      CmsResourceTranslator getTranslation()
      Gets the repository-specific file translations.
      Returns:
      the repository-specific file translations

    • initializeCms

      void initializeCms(CmsObject cms) throws CmsException
      Initializes this repository with an admin CMS object.

      Parameters:
      cms - an admin CMS object
      Throws:
      CmsException - if something goes wrong

    • isTranslationEnabled

      boolean isTranslationEnabled()
      Returns true if the repository specific file translations are enabled (they may also be set without being enabled).
      Returns:
      true if the file translations are enabled

    • setFilter

      void setFilter(CmsRepositoryFilter filter)
      Sets the repository filter.

      Parameters:
      filter - the repository filter

    • setName

      void setName(String name)
      Sets the name for this repository.

      Parameters:
      name - the name to use for the repository

    • setTranslation

      void setTranslation(CmsResourceTranslator translator, boolean enabled)
      Sets the repository-specific file translations
      Parameters:
      translator - the file translations
      enabled - true if the translations should be enabled