org.ametys.cms.tag

Interface TagProvider

All Known Implementing Classes:

JCRTagProvider, JCRTagProvider, SkinTagProvider, StaticTagProvider

public interface TagProvider

This interface represents a tag provider.

Method Summary

Modifier and Type	Method and Description
I18nizableText	getDescription() Returns the provider's description.
Map<String,Tag>	getFilteredTags(String targetType, Map<String,Object> contextualParameters) Returns the provider's tags filtered by target type
String	getId() Returns the provider's id.
I18nizableText	getLabel() Returns the provider's label.
Tag	getTag(String tagName, Map<String,Object> contextualParameters) Returns the provider's tag.
Map<String,Tag>	getTags(Map<String,Object> contextualParameters) Returns the provider's tags.
Collection<Tag>	getTags(String tagName, Map<String,Object> contextualParameters) Returns the direct children of the provider's tag.
boolean	hasTag(String tagName, Map<String,Object> contextualParameters) Determines if the tag exists.

Method Detail

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,Tag> getTags(Map<String,Object> contextualParameters)

Returns the provider's tags.

Parameters:

contextualParameters - contextual parameters

Returns:

the provider's tags.

getFilteredTags

Map<String,Tag> getFilteredTags(String targetType,
                                Map<String,Object> contextualParameters)

Returns the provider's tags filtered by target type

Parameters:

targetType - If not null, returns only tags matching this target type

contextualParameters - contextual parameters

Returns:

the provider's tags.

getTag

Tag 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<Tag> 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.