Package org.ametys.cms.tag

Interface TagProvider<T extends Tag>

Type Parameters:
T - the tag class
All Known Implementing Classes:
AbstractJCRTagProvider, AbstractTagProvider, CategoryJCRProvider, CategoryTagProvider, CMSJCRTagProvider, GroupTagProvider, GroupTagProvider, JCRThemeProvider, KeywordJCRProvider, KeywordTagProvider, ProjectCMSTagProvider, ProjectJCRTagProvider, SkinTagProvider, SkinThemeProvider, StaticTagProvider, WEBJCRTagProvider
public interface TagProvider<T extends Tag>
This interface represents a tag provider.

  • Method Details

    • getId

      String getId()
      Returns the provider's id.
      Returns:
      the provider's id.

    • getLabel

      I18nizableText getLabel()
      Returns the provider's label.
      Returns:
      the provider's label.

    • getDescription

      I18nizableText getDescription()
      Returns the provider's description.
      Returns:
      the provider's description.

    • getTags

      Map<String,T> getTags(Map<String,Object> contextualParameters)
      Returns the provider's tags.
      Parameters:
      contextualParameters - contextual parameters
      Returns:
      the provider's tags.

    • getTag

      T getTag(String tagName, Map<String,Object> contextualParameters)
      Returns the provider's tag.
      Parameters:
      tagName - The tag name
      contextualParameters - contextual parameters
      Returns:
      the provider's tag.

    • getTags

      Collection<T> getTags(String tagName, Map<String,Object> contextualParameters)
      Returns the direct children of the provider's tag.
      Parameters:
      tagName - The tag name
      contextualParameters - contextual parameters
      Returns:
      the provider's tag.

    • hasTag

      boolean hasTag(String tagName, Map<String,Object> contextualParameters)
      Determines if the tag exists.
      Parameters:
      tagName - The tag unique name
      contextualParameters - contextual parameters
      Returns:
      true if the tag exists.