Class SoapTagClient
java.lang.Object
com.logicaldoc.webservice.soap.client.SoapClient<TagService>
com.logicaldoc.webservice.soap.client.SoapTagClient
- All Implemented Interfaces:
TagService
Tag Web Service client.
- Since:
- 7.6.3
- Author:
- Marco Meschieri - LogicalDOC
-
Constructor Summary
ConstructorDescriptionSoapTagClient
(String endpoint) SoapTagClient
(String endpoint, int gzipThreshold, boolean log, int timeout) -
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
-
Constructor Details
-
SoapTagClient
-
SoapTagClient
-
-
Method Details
-
setDocumentTags
public void setDocumentTags(String sid, long docId, List<String> tags) throws AuthenticationException, PermissionException, WebserviceException, PersistenceException, UnexistingResourceException Description copied from interface:TagService
Sets the tags of a document- Specified by:
setDocumentTags
in interfaceTagService
- Parameters:
sid
- identifier of the sessiondocId
- identifier of the documenttags
- list of tags- Throws:
AuthenticationException
- Invalid sessionPermissionException
- The user does not have the required permissionWebserviceException
- Error in the webservicePersistenceException
- Error in the databaseUnexistingResourceException
- The specified document does not exist
-
addDocumentTags
public void addDocumentTags(String sid, long docId, List<String> tags) throws AuthenticationException, PermissionException, WebserviceException, PersistenceException, UnexistingResourceException Description copied from interface:TagService
Adds tags to a document- Specified by:
addDocumentTags
in interfaceTagService
- Parameters:
sid
- Session IdentifierdocId
- identifier of the documenttags
- list of tags- Throws:
AuthenticationException
- Invalid sessionPermissionException
- The user does not have the required permissionWebserviceException
- Error in the webservicePersistenceException
- Error in the databaseUnexistingResourceException
- The specified document does not exist
-
getDocumentTags
public List<String> getDocumentTags(String sid, long docId) throws PermissionException, AuthenticationException, PersistenceException, WebserviceException, UnexistingResourceException Description copied from interface:TagService
Retrieves all the tags of a document.- Specified by:
getDocumentTags
in interfaceTagService
- Parameters:
sid
- identifier of the sessiondocId
- identifier of the document- Returns:
- The tags of the document
- Throws:
PermissionException
- The user does not have the required permissionAuthenticationException
- Invalid sessionPersistenceException
- Error in the databaseWebserviceException
- Error in the webserviceUnexistingResourceException
- The specified document does not exist
-
setFolderTags
public void setFolderTags(String sid, long folderId, List<String> tags) throws AuthenticationException, PermissionException, WebserviceException, PersistenceException Description copied from interface:TagService
Sets the tags of a folder- Specified by:
setFolderTags
in interfaceTagService
- Parameters:
sid
- Session IdentifierfolderId
- identifier of the foldertags
- list of tags- Throws:
AuthenticationException
- Invalid sessionPermissionException
- The user does not have the required permissionWebserviceException
- Error in the webservicePersistenceException
- Error in the database
-
addFolderTags
public void addFolderTags(String sid, long folderId, List<String> tags) throws AuthenticationException, PermissionException, WebserviceException, PersistenceException Description copied from interface:TagService
Adds tags to a folder- Specified by:
addFolderTags
in interfaceTagService
- Parameters:
sid
- Session IdentifierfolderId
- identifier of the foldertags
- list of tags- Throws:
AuthenticationException
- Invalid sessionPermissionException
- The user does not have the required permissionWebserviceException
- Error in the webservicePersistenceException
- Error in the database
-
getFolderTags
public List<String> getFolderTags(String sid, long folderId) throws PermissionException, AuthenticationException, PersistenceException, WebserviceException Description copied from interface:TagService
Retrieves all the tags of a folder- Specified by:
getFolderTags
in interfaceTagService
- Parameters:
sid
- Session IdentifierfolderId
- identifier of the folder- Returns:
- The tags of the folder
- Throws:
PermissionException
- The user does not have the required permissionAuthenticationException
- Invalid sessionPersistenceException
- Error in the databaseWebserviceException
- Error in the webservice
-
getTags
public List<String> getTags(String sid) throws AuthenticationException, PersistenceException, WebserviceException Description copied from interface:TagService
Retrieves all the tags in the repository- Specified by:
getTags
in interfaceTagService
- Parameters:
sid
- Session Identifier- Returns:
- The tags in the repository
- Throws:
AuthenticationException
- Invalid sessionPersistenceException
- Error in the databaseWebserviceException
- Error in the webservice
-
getTagCloud
public List<WSTagCloud> getTagCloud(String sid) throws AuthenticationException, PersistenceException, WebserviceException Description copied from interface:TagService
Retrieves all tag clouds in the repository.- Specified by:
getTagCloud
in interfaceTagService
- Parameters:
sid
- identifier of the session- Returns:
- The tags in the repository
- Throws:
AuthenticationException
- Invalid sessionPersistenceException
- Error in the databaseWebserviceException
- Error in the webservice
-
findDocumentsByTag
public List<WSDocument> findDocumentsByTag(String sid, String tag) throws AuthenticationException, PersistenceException, WebserviceException Description copied from interface:TagService
Finds authorized documents for the current user having a specified tag- Specified by:
findDocumentsByTag
in interfaceTagService
- Parameters:
sid
- identifier of the sessiontag
- tag of the document- Returns:
- Collection of found documents
- Throws:
AuthenticationException
- Invalid sessionPersistenceException
- Error in the databaseWebserviceException
- Error in the webservice
-
findFoldersByTag
public List<WSFolder> findFoldersByTag(String sid, String tag) throws AuthenticationException, WebserviceException, PersistenceException Description copied from interface:TagService
Finds authorized folders for the current user having a specified tag- Specified by:
findFoldersByTag
in interfaceTagService
- Parameters:
sid
- identifier of the sessiontag
- tag of the folder- Returns:
- Collection of found folders
- Throws:
AuthenticationException
- Invalid sessionWebserviceException
- Error in the webservicePersistenceException
- Error in the database
-
getTagsPreset
public List<String> getTagsPreset(String sid) throws AuthenticationException, WebserviceException, PersistenceException Description copied from interface:TagService
Retrieves all the tags in the preset(if the input mode is preset).- Specified by:
getTagsPreset
in interfaceTagService
- Parameters:
sid
- identifier of the session- Returns:
- The tags in the preset
- Throws:
AuthenticationException
- Invalid sessionWebserviceException
- Error in the webservicePersistenceException
- Error in the database
-