TaggingService (Alfresco 5.0.3 Public API)

org.alfresco.service.cmr.tagging

Interface TaggingService

public interface TaggingService

Tagging Service Interface

Method Summary
NodeRef	addTag(NodeRef nodeRef, String tag) Add a tag to a node.
List<Pair<String,NodeRef>>	addTags(NodeRef nodeRef, List<String> tags) Adds a list of tags to a node.
void	addTagScope(NodeRef nodeRef) Adds a tag scope to the specified node
NodeRef	changeTag(StoreRef storeRef, String existingTag, String newTag)
void	clearTags(NodeRef nodeRef) Clears all tags from an already tagged node.
NodeRef	createTag(StoreRef storeRef, String tag) Create a new tag
void	deleteTag(StoreRef storeRef, String tag) Delete an existing tag
List<org.alfresco.service.cmr.tagging.TagScope>	findAllTagScopes(NodeRef nodeRef) Finds all the tag scopes for the specified node.
List<NodeRef>	findTaggedNodes(StoreRef storeRef, String tag) Find all nodes that have been tagged with the specified tag.
List<NodeRef>	findTaggedNodes(StoreRef storeRef, String tag, NodeRef nodeRef) Find all nodes that have been tagged with the specified tag and reside within the context of the node reference provided.
org.alfresco.service.cmr.tagging.TagScope	findTagScope(NodeRef nodeRef) Finds the 'nearest' tag scope for the specified node.
Pair<List<String>,Integer>	getPagedTags(StoreRef storeRef, int fromTag, int pageSize) Get page of the tags currently available
Pair<List<String>,Integer>	getPagedTags(StoreRef storeRef, String filter, int fromTag, int pageSize)
String	getTagName(NodeRef nodeRef)
NodeRef	getTagNodeRef(StoreRef storeRef, String tag) Gets the node reference for a given tag.
List<String>	getTags(NodeRef nodeRef) Get all the tags on a node
PagingResults<Pair<NodeRef,String>>	getTags(NodeRef nodeRef, PagingRequest pagingRequest) Get a paged list of all the tags on a node
List<String>	getTags(StoreRef storeRef) Get all the tags currently available
PagingResults<Pair<NodeRef,String>>	getTags(StoreRef storeRef, PagingRequest pagingRequest) Get a paged list of all the tags currently available
List<String>	getTags(StoreRef storeRef, String filter) Get all the tags currently available that match the provided filter.
boolean	hasTag(NodeRef nodeRef, String tag) Indicates whether a node has the specified tag or not.
boolean	isTag(StoreRef storeRef, String tag) Indicates whether the tag already exists
boolean	isTagScope(NodeRef nodeRef) Indicates whether the node reference is a tag scope
void	refreshTagScope(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(NodeRef nodeRef, String tag) Remove a tag from a node.
void	removeTags(NodeRef nodeRef, List<String> tags) Removes a list of tags from a node.
void	removeTagScope(NodeRef nodeRef) Removes a tag scope from a specified node.
void	setTags(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(StoreRef storeRef,
String tag)

Indicates whether the tag already exists

storeRef - store reference

boolean true if the tag exists, false otherwise

String getTagName(NodeRef nodeRef)

@NotAuditable
List<String> getTags(StoreRef storeRef)

Get all the tags currently available

Get a paged list of all the tags currently available

pagingRequest - PagingRequest

@NotAuditable
List<String> getTags(StoreRef storeRef,
String filter)

Get all the tags currently available that match the provided filter.

storeRef - store reference

@Auditable(parameters="tag")
NodeRef createTag(StoreRef storeRef,
String tag)

storeRef - store reference

@Auditable(parameters="tag")
void deleteTag(StoreRef storeRef,
String tag)

Delete an existing tag

storeRef - store reference

@Auditable(parameters={
  "existingTag",
  "newTag"
})
NodeRef changeTag(StoreRef storeRef,
                  String existingTag,
                  String newTag)

@Auditable(parameters="tag")
boolean hasTag(NodeRef nodeRef,
String tag)

Indicates whether a node has the specified tag or not.

nodeRef - node reference

boolean true if the node has the tag, false otherwise

@Auditable(parameters="tag")
NodeRef addTag(NodeRef nodeRef,
String tag)

Add a tag to a node. Creating the tag if it does not already exist.

nodeRef - node reference

@NotAuditable
NodeRef getTagNodeRef(StoreRef storeRef,
String tag)

Gets the node reference for a given tag.

Returns null if tag is not present.

storeRef - store reference

NodeRef tag node reference or null not exist

@Auditable(parameters="tags")
List<Pair<String,NodeRef>> addTags(NodeRef nodeRef,
List<String> tags)

Adds a list of tags to a node.

Tags are created if they do not exist.

nodeRef - node reference

@Auditable(parameters="tag")
void removeTag(NodeRef nodeRef,
String tag)

Remove a tag from a node.

nodeRef - node reference

@Auditable(parameters="tags")
void removeTags(NodeRef nodeRef,
List<String> tags)

Removes a list of tags from a node.

nodeRef - node reference

@NotAuditable
List<String> getTags(NodeRef nodeRef)

Get all the tags on a node

nodeRef - node reference

List list of tags on the node

Get a paged list of all the tags on a node

nodeRef - node reference

PagingResults list of tags on the node

@Auditable(parameters="tags")
void setTags(NodeRef nodeRef,
List<String> tags)

Sets the list of tags that are applied to a node, replaces any existing tags with those provided.

nodeRef - node reference

@Auditable
void clearTags(NodeRef nodeRef)

Clears all tags from an already tagged node.

nodeRef - node reference

@NotAuditable
boolean isTagScope(NodeRef nodeRef)

Indicates whether the node reference is a tag scope

nodeRef - node reference

boolean true if node is a tag scope, false otherwise

@Auditable
void addTagScope(NodeRef nodeRef)

Adds a tag scope to the specified node

nodeRef - node reference

@Auditable
void refreshTagScope(NodeRef nodeRef,
boolean async)

Refreshes the tag count of the passed tag scope by recounting all the tags of the children of the scope.

nodeRef - tag scope node reference

async - indicates whether the tag scope refresh should happen asynchronously or not

@Auditable
void removeTagScope(NodeRef nodeRef)

Removes a tag scope from a specified node. Note that any tag count information will be lost when the scope if removed.

nodeRef - node reference

@NotAuditable
org.alfresco.service.cmr.tagging.TagScope findTagScope(NodeRef nodeRef)

Finds the 'nearest' tag scope for the specified node.

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

the 'nearest' tag scope or null if none found

@NotAuditable
List<org.alfresco.service.cmr.tagging.TagScope> findAllTagScopes(NodeRef nodeRef)

Finds all the tag scopes for the specified node.

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

List list of tag scopes

@NotAuditable
List<NodeRef> findTaggedNodes(StoreRef storeRef,
String tag)

Find all nodes that have been tagged with the specified tag.

List list of nodes tagged with specified tag, empty of none found

@NotAuditable
List<NodeRef> findTaggedNodes(StoreRef storeRef,
String tag,
NodeRef nodeRef)

Find all nodes that have been tagged with the specified tag and reside within the context of the node reference provided.

nodeRef - node providing context for the search

List list of nodes tagged in the context specified, empty if none found

@NotAuditable
Pair<List<String>,Integer> getPagedTags(StoreRef storeRef,
int fromTag,
int pageSize)

Get page of the tags currently available

storeRef - node reference

pageSize - page size

pair of tag names and total count

@NotAuditable
Pair<List<String>,Integer> getPagedTags(StoreRef storeRef,
                                        String filter,
                                        int fromTag,
                                        int pageSize)

storeRef - node reference

fromTag - page offset

pageSize - page size

pair of tag names and total count

Java API documentation generated with DocFlex/Javadoc 1.6.1 using JavadocPro template set.