Package com.logicaldoc.webservice.rest
Interface TagService
-
- All Known Implementing Classes:
RestTagService
,RestTagSwagger
@Consumes({"application/xml","application/json"}) @Produces("application/json") public interface TagService
Tag Web Service definition interface for REST. Marco Meschieri - LogicalDOC- Since:
- 7.6.3
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addDocumentTags(long docId, String[] tags)
Adds tags to a documentvoid
addFolderTags(long folderId, String[] tags)
Adds tags to a folderWSDocument[]
findDocumentsByTag(String tag)
Finds authorized documents for the current user having a specified tagWSFolder[]
findFoldersByTag(String tag)
Finds authorized folders for the current user having a specified tag.String[]
getDocumentTags(long docId)
Retrieves all the tags of a documentString[]
getFolderTags(long folderId)
Retrieves all the tags of a folderWSTagCloud[]
getTagCloud()
Retrieves all tag clouds in the repositoryString[]
getTags()
Retrieves all the tags in the repositoryString[]
getTagsPreset()
Retrieves all the tags in the preset (if the input mode is preset).void
setDocumentTags(long docId, String[] tags)
Sets the tags of a documentvoid
setFolderTags(long folderId, String[] tags)
Sets the tags of a folder
-
-
-
Method Detail
-
setDocumentTags
@POST @Path("/setDocumentTags") void setDocumentTags(@FormParam("docId") long docId, @FormParam("tag") String[] tags) throws Exception
Sets the tags of a document- Parameters:
docId
- identifier of the documenttags
- array of tags- Throws:
Exception
- error in the server application
-
addDocumentTags
@POST @Path("/addDocumentTags") void addDocumentTags(@FormParam("docId") long docId, @FormParam("tag") String[] tags) throws Exception
Adds tags to a document- Parameters:
docId
- identifier of the documenttags
- array of tags- Throws:
Exception
- error in the server application
-
getDocumentTags
@GET @Path("/getDocumentTags") String[] getDocumentTags(@QueryParam("docId") long docId) throws Exception
Retrieves all the tags of a document- Parameters:
docId
- identifier of the document- Returns:
- The tags of the document
- Throws:
Exception
- error in the server application
-
setFolderTags
@POST @Path("/setFolderTags") void setFolderTags(@FormParam("folderId") long folderId, @FormParam("tag") String[] tags) throws Exception
Sets the tags of a folder- Parameters:
folderId
- identifier of the foldertags
- list of tags- Throws:
Exception
- error in the server application
-
addFolderTags
@POST @Path("/addFolderTags") void addFolderTags(@FormParam("folderId") long folderId, @FormParam("tag") String[] tags) throws Exception
Adds tags to a folder- Parameters:
folderId
- identifier of the foldertags
- list of tags- Throws:
Exception
- error in the server application
-
getFolderTags
@GET @Path("/getFolderTags") String[] getFolderTags(@FormParam("folderId") long folderId) throws Exception
Retrieves all the tags of a folder- Parameters:
folderId
- identifier of the folder- Returns:
- The tags of the folder
- Throws:
Exception
- error in the server application
-
getTags
@GET @Path("/getTags") String[] getTags() throws Exception
Retrieves all the tags in the repository- Returns:
- The tags in the repository
- Throws:
Exception
- error in the server application
-
getTagCloud
@GET @Path("/getTagCloud") WSTagCloud[] getTagCloud() throws Exception
Retrieves all tag clouds in the repository- Returns:
- The tags in the repository
- Throws:
Exception
- error in the server application
-
findDocumentsByTag
@GET @Path("/findDocumentsByTag") WSDocument[] findDocumentsByTag(@QueryParam("tag") String tag) throws Exception
Finds authorized documents for the current user having a specified tag- Parameters:
tag
- Tag of the document- Returns:
- Collection of found documents
- Throws:
Exception
- error in the server application
-
findFoldersByTag
@GET @Path("/findFoldersByTag") WSFolder[] findFoldersByTag(@QueryParam("tag") String tag) throws Exception
Finds authorized folders for the current user having a specified tag.- Parameters:
tag
- Tag of the folder- Returns:
- Collection of found folders
- Throws:
Exception
- error in the server application
-
-