public interface TagService
Modifier and Type | Method and Description |
---|---|
void |
copyTags(CoreSession session,
String srcDocId,
String dstDocId)
Copy all the tags applied to the source document to the destination document.
|
List<Tag> |
getDocumentTags(CoreSession session,
String docId,
String username)
Gets the tags applied to a document by a given user, or by all users.
|
List<Tag> |
getDocumentTags(CoreSession session,
String docId,
String username,
boolean useCore)
Gets the tags applied to a document by a given user, or by all users.
|
List<Tag> |
getSuggestions(CoreSession session,
String label,
String username)
Gets suggestions for a given tag label prefix.
|
List<Tag> |
getTagCloud(CoreSession session,
String docId,
String username,
Boolean normalize)
Gets the tag cloud for a set of documents (tags with weight corresponding to their popularity).
|
List<String> |
getTagDocumentIds(CoreSession session,
String label,
String username)
Gets the documents to which a tag is applied.
|
boolean |
isEnabled()
Defines if tag service is enable.
|
void |
removeTags(CoreSession session,
String docId)
Removes all the tags applied to a document.
|
void |
replaceTags(CoreSession session,
String srcDocId,
String dstDocId)
Replace all the existing tags applied on the destination document by the ones applied on the source document.
|
void |
tag(CoreSession session,
String docId,
String label,
String username)
Tags a document with a given tag.
|
void |
untag(CoreSession session,
String docId,
String label,
String username)
Untags a document of the given tag
|
static final String ID
boolean isEnabled()
void tag(CoreSession session, String docId, String label, String username)
session
- the sessiondocId
- the document idlabel
- the tagusername
- the user associated to the taggingvoid untag(CoreSession session, String docId, String label, String username)
session
- the sessiondocId
- the document idlabel
- the tag, or null
for all tagsusername
- the user associated to the taggingList<Tag> getDocumentTags(CoreSession session, String docId, String username)
session
- the sessiondocId
- the document idusername
- the user name, or null
for all usersList<Tag> getDocumentTags(CoreSession session, String docId, String username, boolean useCore)
Alternative method allowing to specify whether the core should be used for this query.
session
- the sessiondocId
- the document idusername
- the user name, or null
for all usersuseCore
- if true, the core should be used to retrieve tags.void removeTags(CoreSession session, String docId)
void copyTags(CoreSession session, String srcDocId, String dstDocId)
The tags are merged.
srcDocId
- the source document iddstDocId
- the destination document idvoid replaceTags(CoreSession session, String srcDocId, String dstDocId)
srcDocId
- the source document iddstDocId
- the destination document idList<String> getTagDocumentIds(CoreSession session, String label, String username)
session
- the sessionlabel
- the tagusername
- the user name, or null
for all usersList<Tag> getTagCloud(CoreSession session, String docId, String username, Boolean normalize)
If a docId is passed, only documents under it are considered, otherwise all documents in the database are used.
The cloud is returned unsorted.
session
- the sessiondocId
- the document id under which to look, or null
for all documentsusername
- the user name, or null
for all usersnormalize
- null for no weight normalization (a count is returned), FALSE
for 0-100 normalization,
TRUE
for logarithmic 0-100 normalizationList<Tag> getSuggestions(CoreSession session, String label, String username)
session
- the sessionlabel
- the tag label prefixusername
- the user name, or null
for all usersCopyright © 2015 Nuxeo SA. All rights reserved.