|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface TaggingService
Tagging Service Interface
Method Summary | |
---|---|
void |
addTag(org.alfresco.service.cmr.repository.NodeRef nodeRef,
java.lang.String tag)
Add a tag to a node. |
void |
addTags(org.alfresco.service.cmr.repository.NodeRef nodeRef,
java.util.List 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 |
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,
java.lang.String tag)
Create a new tag |
void |
deleteTag(org.alfresco.service.cmr.repository.StoreRef storeRef,
java.lang.String tag)
Delete an existing tag |
java.util.List |
findAllTagScopes(org.alfresco.service.cmr.repository.NodeRef nodeRef)
Finds all the tag scopes for the specified node. |
java.util.List |
findTaggedNodes(org.alfresco.service.cmr.repository.StoreRef storeRef,
java.lang.String tag)
Find all nodes that have been tagged with the specified tag. |
java.util.List |
findTaggedNodes(org.alfresco.service.cmr.repository.StoreRef storeRef,
java.lang.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.service.cmr.repository.NodeRef |
getTagNodeRef(org.alfresco.service.cmr.repository.StoreRef storeRef,
java.lang.String tag)
Gets the node reference for a given tag. |
java.util.List |
getTags(org.alfresco.service.cmr.repository.NodeRef nodeRef)
Get all the tags on a node |
java.util.List |
getTags(org.alfresco.service.cmr.repository.StoreRef storeRef)
Get all the tags currently available |
java.util.List |
getTags(org.alfresco.service.cmr.repository.StoreRef storeRef,
java.lang.String filter)
Get all the tags currently available that match the provided filter. |
boolean |
hasTag(org.alfresco.service.cmr.repository.NodeRef nodeRef,
java.lang.String tag)
Indicates whether a node has the specified tag or not. |
boolean |
isTag(org.alfresco.service.cmr.repository.StoreRef storeRef,
java.lang.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,
java.lang.String tag)
Remove a tag from a node. |
void |
removeTags(org.alfresco.service.cmr.repository.NodeRef nodeRef,
java.util.List 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,
java.util.List tags)
Sets the list of tags that are applied to a node, replaces any existing tags with those provided. |
Method Detail |
---|
@NotAuditable boolean isTag(org.alfresco.service.cmr.repository.StoreRef storeRef, java.lang.String tag)
storeRef
- store referencetag
- tag name
@NotAuditable java.util.List getTags(org.alfresco.service.cmr.repository.StoreRef storeRef)
@NotAuditable java.util.List getTags(org.alfresco.service.cmr.repository.StoreRef storeRef, java.lang.String filter)
storeRef
- store referencefilter
- tag filter
@Auditable(parameters="tag") org.alfresco.service.cmr.repository.NodeRef createTag(org.alfresco.service.cmr.repository.StoreRef storeRef, java.lang.String tag)
storeRef
- store referencetag
- tag name@Auditable(parameters="tag") void deleteTag(org.alfresco.service.cmr.repository.StoreRef storeRef, java.lang.String tag)
storeRef
- store referencetag
- tag name@Auditable(parameters="tag") boolean hasTag(org.alfresco.service.cmr.repository.NodeRef nodeRef, java.lang.String tag)
nodeRef
- node referencetag
- tag name
@Auditable(parameters="tag") void addTag(org.alfresco.service.cmr.repository.NodeRef nodeRef, java.lang.String tag)
nodeRef
- node referencetag
- tag name@NotAuditable org.alfresco.service.cmr.repository.NodeRef getTagNodeRef(org.alfresco.service.cmr.repository.StoreRef storeRef, java.lang.String tag)
Returns null if tag is not present.
storeRef
- store referencetag
- tag
@Auditable(parameters="tags") void addTags(org.alfresco.service.cmr.repository.NodeRef nodeRef, java.util.List 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, java.lang.String tag)
nodeRef
- node referencetag
- tag name@Auditable(parameters="tags") void removeTags(org.alfresco.service.cmr.repository.NodeRef nodeRef, java.util.List tags)
nodeRef
- node referencetags
- list of tags@NotAuditable java.util.List getTags(org.alfresco.service.cmr.repository.NodeRef nodeRef)
nodeRef
- node reference
@Auditable(parameters="tags") void setTags(org.alfresco.service.cmr.repository.NodeRef nodeRef, java.util.List 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 java.util.List 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 java.util.List findTaggedNodes(org.alfresco.service.cmr.repository.StoreRef storeRef, java.lang.String tag)
tag
- tag name
@NotAuditable java.util.List findTaggedNodes(org.alfresco.service.cmr.repository.StoreRef storeRef, java.lang.String tag, org.alfresco.service.cmr.repository.NodeRef nodeRef)
tag
- tag namenodeRef
- node providing context for the search
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |