public interface SocialTagManager extends TagManager
SocialTagManager
is an extension to TagManager
interface for Adobe Cloud Storage.TagManager.FindResults
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.
|
java.util.List<java.lang.String> |
findTagIDsByTitle(java.lang.String title)
Call
TagManager.findByTitle(String) and return a list of tagIDs instead of
TagManager.FindResults |
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.
|
canCreateTag, canCreateTagByTitle, canCreateTagByTitle, createTag, createTag, createTagByTitle, createTagByTitle, createTagByTitle, deleteTag, deleteTag, find, find, find, find, findByTitle, findTagsByKeyword, findTagsByTitle, getNamespaces, getNamespacesIter, getResourceResolver, getSession, getSupportedLanguageCodes, getTags, getTagsForSubtree, mergeTag, moveTag, resolve, resolveByTitle, resolveByTitle, setTags, setTags
boolean isUserGeneratedTag(java.lang.String tagID)
tagID
- can be the name/ID mytag
or namespace:group/tag
or the absolute path to
resource.boolean isFlaggedForModeration(java.lang.String tagID)
tagID
- can be the name/ID mytag
or namespace:group/tag
or the absolute path to
resource.void flagForModeration(Tag tag)
tag
- a user generated tagvoid removeModerationFlag(Tag tag)
tag
- a user generated tag that was flaggedboolean canCreateUserGeneratedTag(java.lang.String tagID) throws InvalidTagFormatException
TagManager
's canCreateTag, which is not for user generated tags.tagID
- can be the name/ID mytag
or namespace:group/tag
or the absolute path to
resource.InvalidTagFormatException
- if tagID doen't adhere to formating rulesTag createUserGeneratedTag(java.lang.String tagID) throws InvalidTagFormatException
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:
InvalidTagFormatException
- if tagID doen't adhere to formating rulesTag[] getUserGeneratedNamespaces()
void addTagsTo(Resource resource, Tag[] tags)
resource
- an existing resource that may already have tagstags
- an array of tagsvoid removeTagsFrom(Resource resource, Tag[] tags)
resource
- an resource an existing resourcetags
- an array of tagsvoid removeAllTagsFrom(Resource resource)
resource
- the tags to remove all its tagsTag resolveRawTagByPath(java.lang.String absPath)
absPath
- absolute path to tag resource, such as /content/cq:tags/namespace/mytag
SocialTagImpl
instance for the tag resources stored at the given path, null
if
not foundTag[] searchWordsToTags(java.lang.String[] searchWords, boolean isUserGenerated)
searchWords
- an array of search terms which a user enteredisUserGenerated
- whether to resolve in the user generated path, if true
, otherwise in the
base CQ path.Tag[] searchWordsToTags(java.lang.String[] searchWords, boolean isUserGenerated, java.util.Locale locale)
searchWords
- an array of search terms which a user enteredisUserGenerated
- 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.java.util.Map<Tag,java.lang.Integer> getTagFacetForSubtree(Resource resource)
resource
- Resourcejava.util.List<java.lang.String> findTagIDsByTitle(java.lang.String title)
TagManager.findByTitle(String)
and return a list of tagIDs instead of
TagManager.FindResults
title
- title of tag to findCopyright © 2010 - 2020 Adobe. All Rights Reserved