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, String[] tags)	Adds tags to a document
void	addFolderTags(String sid, long folderId, String[] tags)	Adds tags to a folder
WSDocument[]	findDocumentsByTag(String sid, String tag)	Finds authorized documents for the current user having a specified tag
WSFolder[]	findFoldersByTag(String sid, String tag)	Finds authorized folders for the current user having a specified tag
String[]	getDocumentTags(String sid, long docId)	Retrieves all the tags of a document.
String[]	getFolderTags(String sid, long folderId)	Retrieves all the tags of a folder
WSTagCloud[]	getTagCloud(String sid)	Retrieves all tag clouds in the repository.
String[]	getTags(String sid)	Retrieves all the tags in the repository
String[]	getTagsPreset(String sid)	Retrieves all the tags in the preset(if the input mode is preset).
void	setDocumentTags(String sid, long docId, String[] tags)	Sets the tags of a document
void	setFolderTags(String sid, long folderId, 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 Detail

SoapTagClient

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

Throws:

IOException

SoapTagClient

public SoapTagClient(String endpoint)
              throws IOException

Throws:

IOException

Method Detail

setDocumentTags

public void setDocumentTags(String sid,
                            long docId,
                            String[] tags)
                     throws Exception

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 - array of tags

Throws:

Exception - error in the server application

addDocumentTags

public void addDocumentTags(String sid,
                            long docId,
                            String[] tags)
                     throws Exception

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 - array of tags

Throws:

Exception - error in the server application

getDocumentTags

public String[] getDocumentTags(String sid,
                                long docId)
                         throws Exception

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:

Exception - error in the server application

setFolderTags

public void setFolderTags(String sid,
                          long folderId,
                          String[] tags)
                   throws Exception

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 - array of tags

Throws:

Exception - error in the server application

addFolderTags

public void addFolderTags(String sid,
                          long folderId,
                          String[] tags)
                   throws Exception

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 - array of tags

Throws:

Exception - error in the server application

getFolderTags

public String[] getFolderTags(String sid,
                              long folderId)
                       throws Exception

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:

Exception - error in the server application

getTags

public String[] getTags(String sid)
                 throws Exception

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:

Exception - error in the server application

getTagCloud

public WSTagCloud[] getTagCloud(String sid)
                         throws Exception

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:

Exception - error in the server application

findDocumentsByTag

public WSDocument[] findDocumentsByTag(String sid,
                                       String tag)
                                throws Exception

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:

Exception - error in the server application

findFoldersByTag

public WSFolder[] findFoldersByTag(String sid,
                                   String tag)
                            throws Exception

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:

Exception - error in the server application

getTagsPreset

public String[] getTagsPreset(String sid)
                       throws Exception

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:

Exception - error in the server application