Package com.logicaldoc.webservice.soap
Interface TagService
- All Known Implementing Classes:
RestTagService
,RestTagSwagger
,SoapTagClient
,SoapTagService
public interface TagService
Tag Web Service definition interface
Marco Meschieri - LogicalDOC
- Since:
- 7.6.3
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addDocumentTags
(String sid, long docId, List<String> tags) Adds tags to a documentvoid
addFolderTags
(String sid, long folderId, List<String> tags) Adds tags to a folderfindDocumentsByTag
(String sid, String tag) Finds authorized documents for the current user having a specified tagfindFoldersByTag
(String sid, String tag) Finds authorized folders for the current user having a specified taggetDocumentTags
(String sid, long docId) Retrieves all the tags of a document.getFolderTags
(String sid, long folderId) Retrieves all the tags of a foldergetTagCloud
(String sid) Retrieves all tag clouds in the repository.Retrieves all the tags in the repositorygetTagsPreset
(String sid) Retrieves all the tags in the preset(if the input mode is preset).void
setDocumentTags
(String sid, long docId, List<String> tags) Sets the tags of a documentvoid
setFolderTags
(String sid, long folderId, List<String> tags) Sets the tags of a folder
-
Method Details
-
setDocumentTags
void setDocumentTags(String sid, long docId, List<String> tags) throws AuthenticationException, PermissionException, WebserviceException, PersistenceException, UnexistingResourceException Sets the tags of a document- Parameters:
sid
- identifier of the sessiondocId
- identifier of the documenttags
- list of tags- Throws:
PersistenceException
- Error in the databaseWebserviceException
- Error in the webserviceAuthenticationException
- Invalid sessionPermissionException
- The user does not have the required permissionUnexistingResourceException
- The specified document does not exist
-
addDocumentTags
void addDocumentTags(String sid, long docId, List<String> tags) throws AuthenticationException, PermissionException, WebserviceException, PersistenceException, UnexistingResourceException Adds tags to a document- Parameters:
sid
- Session IdentifierdocId
- identifier of the documenttags
- list of tags- Throws:
PersistenceException
- Error in the databaseWebserviceException
- Error in the webserviceAuthenticationException
- Invalid sessionPermissionException
- The user does not have the required permissionUnexistingResourceException
- The specified document does not exist
-
getDocumentTags
List<String> getDocumentTags(String sid, long docId) throws PermissionException, PersistenceException, AuthenticationException, WebserviceException, UnexistingResourceException Retrieves all the tags of a document.- Parameters:
sid
- identifier of the sessiondocId
- identifier of the document- Returns:
- The tags of the document
- Throws:
PersistenceException
- Error in the databaseWebserviceException
- Error in the webserviceAuthenticationException
- Invalid sessionPermissionException
- The user does not have the required permissionUnexistingResourceException
- The specified document does not exist
-
setFolderTags
void setFolderTags(String sid, long folderId, List<String> tags) throws AuthenticationException, PermissionException, WebserviceException, PersistenceException Sets the tags of a folder- Parameters:
sid
- Session IdentifierfolderId
- identifier of the foldertags
- list of tags- Throws:
PersistenceException
- Error in the databaseWebserviceException
- Error in the webserviceAuthenticationException
- Invalid sessionPermissionException
- The user does not have the required permission
-
addFolderTags
void addFolderTags(String sid, long folderId, List<String> tags) throws AuthenticationException, PermissionException, WebserviceException, PersistenceException Adds tags to a folder- Parameters:
sid
- Session IdentifierfolderId
- identifier of the foldertags
- list of tags- Throws:
PersistenceException
- Error in the databaseWebserviceException
- Error in the webserviceAuthenticationException
- Invalid sessionPermissionException
- The user does not have the required permission
-
getFolderTags
List<String> getFolderTags(String sid, long folderId) throws PermissionException, PersistenceException, AuthenticationException, WebserviceException Retrieves all the tags of a folder- Parameters:
sid
- Session IdentifierfolderId
- identifier of the folder- Returns:
- The tags of the folder
- Throws:
PersistenceException
- Error in the databaseWebserviceException
- Error in the webserviceAuthenticationException
- Invalid sessionPermissionException
- The user does not have the required permission
-
getTags
List<String> getTags(String sid) throws PersistenceException, AuthenticationException, WebserviceException Retrieves all the tags in the repository- Parameters:
sid
- Session Identifier- Returns:
- The tags in the repository
- Throws:
PersistenceException
- Error in the databaseWebserviceException
- Error in the webserviceAuthenticationException
- Invalid session
-
getTagsPreset
List<String> getTagsPreset(String sid) throws AuthenticationException, WebserviceException, PersistenceException Retrieves all the tags in the preset(if the input mode is preset).- Parameters:
sid
- identifier of the session- Returns:
- The tags in the preset
- Throws:
PersistenceException
- Error in the databaseWebserviceException
- Error in the webserviceAuthenticationException
- Invalid session
-
getTagCloud
List<WSTagCloud> getTagCloud(String sid) throws PersistenceException, AuthenticationException, WebserviceException Retrieves all tag clouds in the repository.- Parameters:
sid
- identifier of the session- Returns:
- The tags in the repository
- Throws:
PersistenceException
- Error in the databaseWebserviceException
- Error in the webserviceAuthenticationException
- Invalid session
-
findDocumentsByTag
List<WSDocument> findDocumentsByTag(String sid, String tag) throws PersistenceException, AuthenticationException, WebserviceException Finds authorized documents for the current user having a specified tag- Parameters:
sid
- identifier of the sessiontag
- tag of the document- Returns:
- Collection of found documents
- Throws:
PersistenceException
- Error in the databaseWebserviceException
- Error in the webserviceAuthenticationException
- Invalid session
-
findFoldersByTag
List<WSFolder> findFoldersByTag(String sid, String tag) throws AuthenticationException, WebserviceException, PersistenceException Finds authorized folders for the current user having a specified tag- Parameters:
sid
- identifier of the sessiontag
- tag of the folder- Returns:
- Collection of found folders
- Throws:
PersistenceException
- Error in the databaseWebserviceException
- Error in the webserviceAuthenticationException
- Invalid session
-