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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addDocumentTags(String sid, long docId, String[] tags)
Adds tags to a documentvoid
addFolderTags(String sid, long folderId, String[] tags)
Adds tags to a folderWSDocument[]
findDocumentsByTag(String sid, String tag)
Finds authorized documents for the current user having a specified tagWSFolder[]
findFoldersByTag(String sid, String tag)
Finds authorized folders for the current user having a specified tagString[]
getDocumentTags(String sid, long docId)
Retrieves all the tags of a document.String[]
getFolderTags(String sid, long folderId)
Retrieves all the tags of a folderWSTagCloud[]
getTagCloud(String sid)
Retrieves all tag clouds in the repository.String[]
getTags(String sid)
Retrieves all the tags in the repositoryString[]
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 documentvoid
setFolderTags(String sid, long folderId, String[] tags)
Sets the tags of a folder-
Methods inherited from class com.logicaldoc.webservice.soap.client.SoapClient
setMaxChildElements
-
-
-
-
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 interfaceTagService
- Parameters:
sid
- identifier of the sessiondocId
- identifier of the documenttags
- 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 interfaceTagService
- Parameters:
sid
- Session IdentifierdocId
- identifier of the documenttags
- 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 interfaceTagService
- Parameters:
sid
- identifier of the sessiondocId
- 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 interfaceTagService
- Parameters:
sid
- Session IdentifierfolderId
- identifier of the foldertags
- 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 interfaceTagService
- Parameters:
sid
- Session IdentifierfolderId
- identifier of the foldertags
- 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 interfaceTagService
- Parameters:
sid
- Session IdentifierfolderId
- 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 interfaceTagService
- 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 interfaceTagService
- 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 interfaceTagService
- Parameters:
sid
- identifier of the sessiontag
- 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 interfaceTagService
- Parameters:
sid
- identifier of the sessiontag
- 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 interfaceTagService
- Parameters:
sid
- identifier of the session- Returns:
- The tags in the preset
- Throws:
Exception
- error in the server application
-
-