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

Method Detail

setDocumentTags

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

Sets the tags of a document

Parameters:

sid - identifier of the session

docId - identifier of the document

tags - array of tags

Throws:

Exception - error in the server application

addDocumentTags

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

Adds tags to a document

Parameters:

sid - Session Identifier

docId - identifier of the document

tags - array of tags

Throws:

Exception - error in the server application

getDocumentTags

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

Retrieves all the tags of a document.

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

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

Sets the tags of a folder

Parameters:

sid - Session Identifier

folderId - identifier of the folder

tags - array of tags

Throws:

Exception - error in the server application

addFolderTags

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

Adds tags to a folder

Parameters:

sid - Session Identifier

folderId - identifier of the folder

tags - array of tags

Throws:

Exception - error in the server application

getFolderTags

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

Retrieves all the tags of a folder

Parameters:

sid - Session Identifier

folderId - identifier of the folder

Returns:

The tags of the folder

Throws:

Exception - error in the server application

getTags

String[] getTags(String sid)
          throws Exception

Retrieves all the tags in the repository

Parameters:

sid - Session Identifier

Returns:

The tags in the repository

Throws:

Exception - error in the server application

getTagsPreset

String[] getTagsPreset(String sid)
                throws Exception

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:

Exception - error in the server application

getTagCloud

WSTagCloud[] getTagCloud(String sid)
                  throws Exception

Retrieves all tag clouds in the repository.

Parameters:

sid - identifier of the session

Returns:

The tags in the repository

Throws:

Exception - error in the server application

findDocumentsByTag

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

Finds authorized documents for the current user having a specified tag

Parameters:

sid - identifier of the session

tag - tag of the document

Returns:

Collection of found documents

Throws:

Exception - error in the server application

findFoldersByTag

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

Finds authorized folders for the current user having a specified tag

Parameters:

sid - identifier of the session

tag - tag of the folder

Returns:

Collection of found folders

Throws:

Exception - error in the server application