Package com.logicaldoc.webservice.soap.client

Class SoapTagClient

java.lang.Object

com.logicaldoc.webservice.soap.client.SoapClient<TagService>

com.logicaldoc.webservice.soap.client.SoapTagClient

All Implemented Interfaces:

TagService

public class SoapTagClient
extends SoapClient<TagService>
implements TagService

Tag Web Service client.

Since:

7.6.3

Author:

Marco Meschieri - LogicalDOC

Constructor Summary

Constructors

Constructor	Description
SoapTagClient(String endpoint)
SoapTagClient(String endpoint, int gzipThreshold, boolean log, int timeout)

Method Summary

Modifier and Type	Method	Description
void	addDocumentTags(String sid, long docId, List<String> tags)	Adds tags to a document
void	addFolderTags(String sid, long folderId, List<String> tags)	Adds tags to a folder
List<WSDocument>	findDocumentsByTag(String sid, String tag)	Finds authorized documents for the current user having a specified tag
List<WSFolder>	findFoldersByTag(String sid, String tag)	Finds authorized folders for the current user having a specified tag
List<String>	getDocumentTags(String sid, long docId)	Retrieves all the tags of a document.
List<String>	getFolderTags(String sid, long folderId)	Retrieves all the tags of a folder
List<WSTagCloud>	getTagCloud(String sid)	Retrieves all tag clouds in the repository.
List<String>	getTags(String sid)	Retrieves all the tags in the repository
List<String>	getTagsPreset(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 document
void	setFolderTags(String sid, long folderId, List<String> tags)	Sets the tags of a folder

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SoapTagClient

public SoapTagClient(String endpoint,
 int gzipThreshold,
 boolean log,
 int timeout)

SoapTagClient

public SoapTagClient(String endpoint)

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 interface TagService

Parameters:

sid - identifier of the session

docId - identifier of the document

tags - list of tags

Throws:

AuthenticationException - Invalid session

PermissionException - The user does not have the required permission

WebserviceException - Error in the webservice

PersistenceException - Error in the database

UnexistingResourceException - 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 interface TagService

Parameters:

sid - Session Identifier

docId - identifier of the document

tags - list of tags

Throws:

AuthenticationException - Invalid session

PermissionException - The user does not have the required permission

WebserviceException - Error in the webservice

PersistenceException - Error in the database

UnexistingResourceException - 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 interface TagService

Parameters:

sid - identifier of the session

docId - identifier of the document

Returns:

The tags of the document

Throws:

PermissionException - The user does not have the required permission

AuthenticationException - Invalid session

PersistenceException - Error in the database

WebserviceException - Error in the webservice

UnexistingResourceException - 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 interface TagService

Parameters:

sid - Session Identifier

folderId - identifier of the folder

tags - list of tags

Throws:

AuthenticationException - Invalid session

PermissionException - The user does not have the required permission

WebserviceException - Error in the webservice

PersistenceException - 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 interface TagService

Parameters:

sid - Session Identifier

folderId - identifier of the folder

tags - list of tags

Throws:

AuthenticationException - Invalid session

PermissionException - The user does not have the required permission

WebserviceException - Error in the webservice

PersistenceException - 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 interface TagService

Parameters:

sid - Session Identifier

folderId - identifier of the folder

Returns:

The tags of the folder

Throws:

PermissionException - The user does not have the required permission

AuthenticationException - Invalid session

PersistenceException - Error in the database

WebserviceException - 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 interface TagService

Parameters:

sid - Session Identifier

Returns:

The tags in the repository

Throws:

AuthenticationException - Invalid session

PersistenceException - Error in the database

WebserviceException - 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 interface TagService

Parameters:

sid - identifier of the session

Returns:

The tags in the repository

Throws:

AuthenticationException - Invalid session

PersistenceException - Error in the database

WebserviceException - 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 interface TagService

Parameters:

sid - identifier of the session

tag - tag of the document

Returns:

Collection of found documents

Throws:

AuthenticationException - Invalid session

PersistenceException - Error in the database

WebserviceException - 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 interface TagService

Parameters:

sid - identifier of the session

tag - tag of the folder

Returns:

Collection of found folders

Throws:

AuthenticationException - Invalid session

WebserviceException - Error in the webservice

PersistenceException - 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 interface TagService

Parameters:

sid - identifier of the session

Returns:

The tags in the preset

Throws:

AuthenticationException - Invalid session

WebserviceException - Error in the webservice

PersistenceException - Error in the database