@AlfrescoPublicApi
public interface TaggingService
Modifier and Type | Method and Description |
---|---|
org.alfresco.service.cmr.repository.NodeRef |
addTag(org.alfresco.service.cmr.repository.NodeRef nodeRef,
String tag)
Add a tag to a node.
|
List<org.alfresco.util.Pair<String,org.alfresco.service.cmr.repository.NodeRef>> |
addTags(org.alfresco.service.cmr.repository.NodeRef nodeRef,
List<String> tags)
Adds a list of tags to a node.
|
void |
addTagScope(org.alfresco.service.cmr.repository.NodeRef nodeRef)
Adds a tag scope to the specified node
|
org.alfresco.service.cmr.repository.NodeRef |
changeTag(org.alfresco.service.cmr.repository.StoreRef storeRef,
String existingTag,
String newTag) |
void |
clearTags(org.alfresco.service.cmr.repository.NodeRef nodeRef)
Clears all tags from an already tagged node.
|
org.alfresco.service.cmr.repository.NodeRef |
createTag(org.alfresco.service.cmr.repository.StoreRef storeRef,
String tag)
Create a new tag
|
void |
deleteTag(org.alfresco.service.cmr.repository.StoreRef storeRef,
String tag)
Delete an existing tag and any references to it(cascade delete).
|
List<TagScope> |
findAllTagScopes(org.alfresco.service.cmr.repository.NodeRef nodeRef)
Finds all the tag scopes for the specified node.
|
List<org.alfresco.service.cmr.repository.NodeRef> |
findTaggedNodes(org.alfresco.service.cmr.repository.StoreRef storeRef,
String tag)
Find all nodes that have been tagged with the specified tag.
|
List<org.alfresco.service.cmr.repository.NodeRef> |
findTaggedNodes(org.alfresco.service.cmr.repository.StoreRef storeRef,
String tag,
org.alfresco.service.cmr.repository.NodeRef nodeRef)
Find all nodes that have been tagged with the specified tag and reside within
the context of the node reference provided.
|
TagScope |
findTagScope(org.alfresco.service.cmr.repository.NodeRef nodeRef)
Finds the 'nearest' tag scope for the specified node.
|
org.alfresco.util.Pair<List<String>,Integer> |
getPagedTags(org.alfresco.service.cmr.repository.StoreRef storeRef,
int fromTag,
int pageSize)
Get page of the tags currently available
|
org.alfresco.util.Pair<List<String>,Integer> |
getPagedTags(org.alfresco.service.cmr.repository.StoreRef storeRef,
String filter,
int fromTag,
int pageSize) |
String |
getTagName(org.alfresco.service.cmr.repository.NodeRef nodeRef) |
org.alfresco.service.cmr.repository.NodeRef |
getTagNodeRef(org.alfresco.service.cmr.repository.StoreRef storeRef,
String tag)
Gets the node reference for a given tag.
|
List<String> |
getTags(org.alfresco.service.cmr.repository.NodeRef nodeRef)
Get all the tags on a node
|
org.alfresco.query.PagingResults<org.alfresco.util.Pair<org.alfresco.service.cmr.repository.NodeRef,String>> |
getTags(org.alfresco.service.cmr.repository.NodeRef nodeRef,
org.alfresco.query.PagingRequest pagingRequest)
Get a paged list of all the tags on a node
|
List<String> |
getTags(org.alfresco.service.cmr.repository.StoreRef storeRef)
Get all the tags currently available
|
org.alfresco.query.PagingResults<org.alfresco.util.Pair<org.alfresco.service.cmr.repository.NodeRef,String>> |
getTags(org.alfresco.service.cmr.repository.StoreRef storeRef,
org.alfresco.query.PagingRequest pagingRequest)
Get a paged list of all the tags currently available
|
List<String> |
getTags(org.alfresco.service.cmr.repository.StoreRef storeRef,
String filter)
Get all the tags currently available that match the provided filter.
|
boolean |
hasTag(org.alfresco.service.cmr.repository.NodeRef nodeRef,
String tag)
Indicates whether a node has the specified tag or not.
|
boolean |
isTag(org.alfresco.service.cmr.repository.StoreRef storeRef,
String tag)
Indicates whether the tag already exists
|
boolean |
isTagScope(org.alfresco.service.cmr.repository.NodeRef nodeRef)
Indicates whether the node reference is a tag scope
|
void |
refreshTagScope(org.alfresco.service.cmr.repository.NodeRef nodeRef,
boolean async)
Refreshes the tag count of the passed tag scope by recounting all the tags of the children
of the scope.
|
void |
removeTag(org.alfresco.service.cmr.repository.NodeRef nodeRef,
String tag)
Remove a tag from a node.
|
void |
removeTags(org.alfresco.service.cmr.repository.NodeRef nodeRef,
List<String> tags)
Removes a list of tags from a node.
|
void |
removeTagScope(org.alfresco.service.cmr.repository.NodeRef nodeRef)
Removes a tag scope from a specified node.
|
void |
setTags(org.alfresco.service.cmr.repository.NodeRef nodeRef,
List<String> tags)
Sets the list of tags that are applied to a node, replaces any existing
tags with those provided.
|
@NotAuditable boolean isTag(org.alfresco.service.cmr.repository.StoreRef storeRef, String tag)
storeRef
- store referencetag
- tag nameString getTagName(org.alfresco.service.cmr.repository.NodeRef nodeRef)
@NotAuditable List<String> getTags(org.alfresco.service.cmr.repository.StoreRef storeRef)
@NotAuditable org.alfresco.query.PagingResults<org.alfresco.util.Pair<org.alfresco.service.cmr.repository.NodeRef,String>> getTags(org.alfresco.service.cmr.repository.StoreRef storeRef, org.alfresco.query.PagingRequest pagingRequest)
storeRef
- StoreRefpagingRequest
- PagingRequest@NotAuditable List<String> getTags(org.alfresco.service.cmr.repository.StoreRef storeRef, String filter)
storeRef
- store referencefilter
- tag filter@Auditable(parameters="tag") org.alfresco.service.cmr.repository.NodeRef createTag(org.alfresco.service.cmr.repository.StoreRef storeRef, String tag)
storeRef
- store referencetag
- tag name@Auditable(parameters="tag") void deleteTag(org.alfresco.service.cmr.repository.StoreRef storeRef, String tag)
storeRef
- store referencetag
- tag name@Auditable(parameters={"existingTag","newTag"}) org.alfresco.service.cmr.repository.NodeRef changeTag(org.alfresco.service.cmr.repository.StoreRef storeRef, String existingTag, String newTag)
@Auditable(parameters="tag") boolean hasTag(org.alfresco.service.cmr.repository.NodeRef nodeRef, String tag)
nodeRef
- node referencetag
- tag name@Auditable(parameters="tag") org.alfresco.service.cmr.repository.NodeRef addTag(org.alfresco.service.cmr.repository.NodeRef nodeRef, String tag)
nodeRef
- node referencetag
- tag name@NotAuditable org.alfresco.service.cmr.repository.NodeRef getTagNodeRef(org.alfresco.service.cmr.repository.StoreRef storeRef, String tag)
Returns null if tag is not present.
storeRef
- store referencetag
- tag@Auditable(parameters="tags") List<org.alfresco.util.Pair<String,org.alfresco.service.cmr.repository.NodeRef>> addTags(org.alfresco.service.cmr.repository.NodeRef nodeRef, List<String> tags)
Tags are created if they do not exist.
nodeRef
- node referencetags
- list of tags@Auditable(parameters="tag") void removeTag(org.alfresco.service.cmr.repository.NodeRef nodeRef, String tag)
nodeRef
- node referencetag
- tag name@Auditable(parameters="tags") void removeTags(org.alfresco.service.cmr.repository.NodeRef nodeRef, List<String> tags)
nodeRef
- node referencetags
- list of tags@NotAuditable List<String> getTags(org.alfresco.service.cmr.repository.NodeRef nodeRef)
nodeRef
- node reference@NotAuditable org.alfresco.query.PagingResults<org.alfresco.util.Pair<org.alfresco.service.cmr.repository.NodeRef,String>> getTags(org.alfresco.service.cmr.repository.NodeRef nodeRef, org.alfresco.query.PagingRequest pagingRequest)
nodeRef
- node reference@Auditable(parameters="tags") void setTags(org.alfresco.service.cmr.repository.NodeRef nodeRef, List<String> tags)
nodeRef
- node referencetags
- list of tags@Auditable void clearTags(org.alfresco.service.cmr.repository.NodeRef nodeRef)
nodeRef
- node reference@NotAuditable boolean isTagScope(org.alfresco.service.cmr.repository.NodeRef nodeRef)
nodeRef
- node reference@Auditable void addTagScope(org.alfresco.service.cmr.repository.NodeRef nodeRef)
nodeRef
- node reference@Auditable void refreshTagScope(org.alfresco.service.cmr.repository.NodeRef nodeRef, boolean async)
nodeRef
- tag scope node referenceasync
- indicates whether the tag scope refresh should happen asynchronously or not@Auditable void removeTagScope(org.alfresco.service.cmr.repository.NodeRef nodeRef)
nodeRef
- node reference@NotAuditable TagScope findTagScope(org.alfresco.service.cmr.repository.NodeRef nodeRef)
The 'nearest' tag scope is discovered by walking up the primary parent path until a tag scope is found or the root node is reached.
If no tag scope if found then a null value is returned.
nodeRef
- node reference@NotAuditable List<TagScope> findAllTagScopes(org.alfresco.service.cmr.repository.NodeRef nodeRef)
The resulting list of tag scopes is ordered with the 'nearest' at the bedining of the list.
If no tag scopes are found an empty list is returned.
nodeRef
- node reference@NotAuditable List<org.alfresco.service.cmr.repository.NodeRef> findTaggedNodes(org.alfresco.service.cmr.repository.StoreRef storeRef, String tag)
tag
- tag name@NotAuditable List<org.alfresco.service.cmr.repository.NodeRef> findTaggedNodes(org.alfresco.service.cmr.repository.StoreRef storeRef, String tag, org.alfresco.service.cmr.repository.NodeRef nodeRef)
tag
- tag namenodeRef
- node providing context for the search@NotAuditable org.alfresco.util.Pair<List<String>,Integer> getPagedTags(org.alfresco.service.cmr.repository.StoreRef storeRef, int fromTag, int pageSize)
storeRef
- node referencefromTag
- offsetpageSize
- page size@NotAuditable org.alfresco.util.Pair<List<String>,Integer> getPagedTags(org.alfresco.service.cmr.repository.StoreRef storeRef, String filter, int fromTag, int pageSize)
storeRef
- node referencefilter
- tag filterfromTag
- page offsetpageSize
- page sizeCopyright © 2005–2017 Alfresco Software. All rights reserved.