com.adobe.cq.social.commons.tagging

Interface SocialTagManager

All Superinterfaces:

TagManager

public interface SocialTagManager
extends TagManager

SocialTagManager is an extension to TagManager interface for Adobe Social.

Nested Class Summary

Nested classes/interfaces inherited from interface com.day.cq.tagging.TagManager

TagManager.FindResults

Method Summary

Modifier and Type	Method and Description
void	addTagsTo(Resource resource, Tag[] tags) Add on or multiple tags to a resource.
boolean	canCreateUserGeneratedTag(java.lang.String tagID) Verifies if the user, of the current session, can create a tag in the user generated space.
Tag	createUserGeneratedTag(java.lang.String tagID) Creates a tag or namespace in the use generated space.
void	flagForModeration(Tag tag) Flags the given tag for moderation.
java.util.Map<Tag,java.lang.Integer>	getTagFacetForSubtree(Resource resource) Get the tag facet for the specified target
Tag[]	getUserGeneratedNamespaces() Retrieves all available tag namespaces, in the user generated space, as array.
boolean	isFlaggedForModeration(java.lang.String tagID) Returns true if the given tag was marked for moderation.
boolean	isUserGeneratedTag(java.lang.String tagID) Verifies the creator of tag was indeed a user, not an admin nor moderator.
void	removeAllTagsFrom(Resource resource) Removes all tags from a resource.
void	removeModerationFlag(Tag tag) Removes the moderation flag of a tag.
void	removeTagsFrom(Resource resource, Tag[] tags) Removes one or multiple tags from a resource.
Tag	resolveRawTagByPath(java.lang.String absPath) Returns the tag based on the resource at the given exact repository path.
Tag[]	searchWordsToTags(java.lang.String[] searchWords, boolean isUserGenerated) Resolves search words to tags.
Tag[]	searchWordsToTags(java.lang.String[] searchWords, boolean isUserGenerated, java.util.Locale locale) Resolves search words to tags, while taking in consideration of the locale.

Methods inherited from interface com.day.cq.tagging.TagManager

canCreateTag, canCreateTagByTitle, canCreateTagByTitle, createTag, createTag, createTagByTitle, createTagByTitle, createTagByTitle, deleteTag, deleteTag, find, find, find, find, findByTitle, findTagsByTitle, getNamespaces, getNamespacesIter, getResourceResolver, getSession, getTags, getTagsForSubtree, mergeTag, moveTag, resolve, resolveByTitle, resolveByTitle, setTags, setTags

Method Detail

isUserGeneratedTag

boolean isUserGeneratedTag(java.lang.String tagID)

Verifies the creator of tag was indeed a user, not an admin nor moderator.

Parameters:

tagID - can be the name/ID mytag or namespace:group/tag or the absolute path to resource.

Returns:

true if a user created the tag, otherwise false

isFlaggedForModeration

boolean isFlaggedForModeration(java.lang.String tagID)

Returns true if the given tag was marked for moderation.

Parameters:

tagID - can be the name/ID mytag or namespace:group/tag or the absolute path to resource.

Returns:

true if tag was flagged for moderation, otherwise false or if tag was not user generated

flagForModeration

void flagForModeration(Tag tag)

Flags the given tag for moderation.

Parameters:

tag - a user generated tag

removeModerationFlag

void removeModerationFlag(Tag tag)

Removes the moderation flag of a tag.

Parameters:

tag - a user generated tag that was flagged

canCreateUserGeneratedTag

boolean canCreateUserGeneratedTag(java.lang.String tagID)
                           throws InvalidTagFormatException

Verifies if the user, of the current session, can create a tag in the user generated space. This is not the same as TagManager's canCreateTag, which is not for user generated tags.

Parameters:

tagID - can be the name/ID mytag or namespace:group/tag or the absolute path to resource.

Returns:

true if the user has the needed permissions, false otherwise

Throws:

InvalidTagFormatException - if tagID doen't adhere to formating rules

createUserGeneratedTag

Tag createUserGeneratedTag(java.lang.String tagID)
                    throws InvalidTagFormatException

Creates a tag or namespace in the use generated space.

Parameters:

tagID - Can be the absolute path or tag name/ID such as myTag or namespace:group/myTag. Namespaces can also be defined as absolute path or by the name/ID syntax as such myNameSpace:

Returns:

the newly created tag

Throws:

InvalidTagFormatException - if tagID doen't adhere to formating rules

getUserGeneratedNamespaces

Tag[] getUserGeneratedNamespaces()

Retrieves all available tag namespaces, in the user generated space, as array.

Returns:

all user generated tag namespaces

addTagsTo

void addTagsTo(Resource resource,
               Tag[] tags)

Add on or multiple tags to a resource.

Parameters:

resource - an existing resource that may already have tags

tags - an array of tags

removeTagsFrom

void removeTagsFrom(Resource resource,
                    Tag[] tags)

Removes one or multiple tags from a resource.

Parameters:

resource - an resource an existing resource

tags - an array of tags

removeAllTagsFrom

void removeAllTagsFrom(Resource resource)

Removes all tags from a resource.

Parameters:

resource - the tags to remove all its tags

resolveRawTagByPath

Tag resolveRawTagByPath(java.lang.String absPath)

Returns the tag based on the resource at the given exact repository path. Does not handle if the tag has been moved.

Parameters:

absPath - absolute path to tag resource, such as /etc/tags/namespace/mytag

Returns:

a SocialTagImpl instance for the tag resources stored at the given path, null if not found

searchWordsToTags

Tag[] searchWordsToTags(java.lang.String[] searchWords,
                        boolean isUserGenerated)

Resolves search words to tags.

Parameters:

searchWords - an array of search terms which a user entered

isUserGenerated - whether to resolve in the user generated path, if true, otherwise in the base CQ path.

Returns:

An array of all matching tags from all namespaces. An empty array may be returned if no matching tags were found.

searchWordsToTags

Tag[] searchWordsToTags(java.lang.String[] searchWords,
                        boolean isUserGenerated,
                        java.util.Locale locale)

Resolves search words to tags, while taking in consideration of the locale.

Parameters:

searchWords - an array of search terms which a user entered

isUserGenerated - whether to resolve in the user generated path, if true, otherwise in the base CQ path.

locale - the local to use while resolving the tags.

Returns:

An array of all matching tags from all namespaces. An empty array may be returned if no matching tags were found.

getTagFacetForSubtree

java.util.Map<Tag,java.lang.Integer> getTagFacetForSubtree(Resource resource)

Get the tag facet for the specified target

Parameters:

resource -

Returns:

a map whose keys are the tags, and the values are the count.