Class SoapDocumentMetadataClient
java.lang.Object
com.logicaldoc.webservice.soap.client.SoapClient<DocumentMetadataService>
com.logicaldoc.webservice.soap.client.SoapDocumentMetadataClient
- All Implemented Interfaces:
DocumentMetadataService
public class SoapDocumentMetadataClient
extends SoapClient<DocumentMetadataService>
implements DocumentMetadataService
Document Metadata Web Service client.
- Since:
- 6.1
- Author:
- Matteo Caruso - LogicalDOC
-
Constructor Summary
ConstructorDescriptionSoapDocumentMetadataClient
(String endpoint) SoapDocumentMetadataClient
(String endpoint, int timeout) -
Method Summary
Modifier and TypeMethodDescriptionvoid
addAttributeOption
(String sid, long setId, String attribute, WSAttributeOption wsoption) Add a new option for the given attributevoid
deleteAttributeSet
(String sid, long setId) Deletes an existing attribute set with the given identifier.void
deleteTemplate
(String sid, long templateId) Deletes an existing template with the given identifierString[]
getAttributeOptions
(String sid, long setId, String attribute) Retrieves the options for the given attributegetAttributeOptionsByCategory
(String sid, long setId, String attribute, String category) Retrieves the options for the given attribute inside a given categorygetAttributeSet
(String sid, String name) Gets attribute set's metadatagetAttributeSetById
(String sid, long setId) Gets attribute set's metadataWSRight[]
getGrantedGroups
(String sid, long groupId) Retrieves the list of granted groups for the given templateWSRight[]
getGrantedUsers
(String sid, long groupId) Retrieves the list of granted users for the given template.getTemplate
(String sid, String name) Gets template's metadatagetTemplateById
(String sid, long templateId) Gets template's metadatavoid
grantGroupToTemplate
(String sid, long templateId, long groupId, int permissions) Grants group permission to the template.void
grantUserToTemplate
(String sid, long templateId, long userId, int permissions) Grants user permission to the template.boolean
isTemplateReadable
(String sid, long templateId) Tests if a template is readable.boolean
isTemplateWritable
(String sid, long templateId) Tests if a template is writablelistAttributeSets
(String sid) Gets metadata of all existing attribute sets.listTemplates
(String sid) Gets metadata of all existing templates.void
setAttributeOptions
(String sid, long setId, String attribute, WSAttributeOption[] options) Saves the options for the given attributelong
storeAttributeSet
(String sid, WSAttributeSet attributeSet) Create/Update an attribute set.long
storeTemplate
(String sid, WSTemplate template) Create/Update a template.
-
Constructor Details
-
SoapDocumentMetadataClient
-
SoapDocumentMetadataClient
-
-
Method Details
-
listTemplates
public WSTemplate[] listTemplates(String sid) throws AuthenticationException, WebserviceException, PersistenceException Description copied from interface:DocumentMetadataService
Gets metadata of all existing templates.- Specified by:
listTemplates
in interfaceDocumentMetadataService
- Parameters:
sid
- Session identifier- Returns:
- The list of all templates
- Throws:
AuthenticationException
- Invalid sessionWebserviceException
- Error in the webservicePersistenceException
- Error in the database
-
storeTemplate
public long storeTemplate(String sid, WSTemplate template) throws AuthenticationException, PermissionException, WebserviceException, PersistenceException Description copied from interface:DocumentMetadataService
Create/Update a template. You can completely customize the template through a value object.- Specified by:
storeTemplate
in interfaceDocumentMetadataService
- Parameters:
sid
- Session identifier (need to be administrator)template
- value object containing the template's metadata- Returns:
- The ID of the new template
- Throws:
AuthenticationException
- Invalid sessionPermissionException
- The permission has not been grantedWebserviceException
- Error in the webservicePersistenceException
- Error in the database
-
deleteTemplate
public void deleteTemplate(String sid, long templateId) throws AuthenticationException, PermissionException, WebserviceException, PersistenceException Description copied from interface:DocumentMetadataService
Deletes an existing template with the given identifier- Specified by:
deleteTemplate
in interfaceDocumentMetadataService
- Parameters:
sid
- Session identifier (need to be administrator)templateId
- The template's id- Throws:
AuthenticationException
- Invalid sessionPermissionException
- The permission has not been grantedWebserviceException
- Error in the webservicePersistenceException
- Error in the database
-
getTemplate
public WSTemplate getTemplate(String sid, String name) throws AuthenticationException, WebserviceException, PersistenceException Description copied from interface:DocumentMetadataService
Gets template's metadata- Specified by:
getTemplate
in interfaceDocumentMetadataService
- Parameters:
sid
- Session identifiername
- The template's name- Returns:
- A value object containing the template's metadata.
- Throws:
AuthenticationException
- Invalid sessiononWebserviceException
- Error in the webservicePersistenceException
- Error in the database
-
getTemplateById
public WSTemplate getTemplateById(String sid, long templateId) throws AuthenticationException, WebserviceException, PersistenceException Description copied from interface:DocumentMetadataService
Gets template's metadata- Specified by:
getTemplateById
in interfaceDocumentMetadataService
- Parameters:
sid
- Session identifiertemplateId
- The template's id- Returns:
- A value object containing the template's metadata
- Throws:
AuthenticationException
- Invalid sessionWebserviceException
- Error in the webservicePersistenceException
- Error in the database
-
setAttributeOptions
public void setAttributeOptions(String sid, long setId, String attribute, WSAttributeOption[] options) throws WebserviceException, PersistenceException Description copied from interface:DocumentMetadataService
Saves the options for the given attribute- Specified by:
setAttributeOptions
in interfaceDocumentMetadataService
- Parameters:
sid
- Session identifiersetId
- The attribute set's idattribute
- The attribute's nameoptions
- The attribute's options- Throws:
WebserviceException
- Error in the webservicePersistenceException
- Error in the database
-
getAttributeOptions
public String[] getAttributeOptions(String sid, long setId, String attribute) throws AuthenticationException, WebserviceException, PersistenceException Description copied from interface:DocumentMetadataService
Retrieves the options for the given attribute- Specified by:
getAttributeOptions
in interfaceDocumentMetadataService
- Parameters:
sid
- Session identifiersetId
- The attribute set's idattribute
- The attribute's name- Returns:
- the list of all the attribute's options
- Throws:
AuthenticationException
- Invalid sessionWebserviceException
- Error in the webservicePersistenceException
- Error in the database
-
getAttributeOptionsByCategory
public WSAttributeOption[] getAttributeOptionsByCategory(String sid, long setId, String attribute, String category) throws AuthenticationException, WebserviceException, PersistenceException Description copied from interface:DocumentMetadataService
Retrieves the options for the given attribute inside a given category- Specified by:
getAttributeOptionsByCategory
in interfaceDocumentMetadataService
- Parameters:
sid
- Session identifiersetId
- The attribute set's idattribute
- The attribute's namecategory
- The options category (not mandatory)- Returns:
- the list of all the attribute's options
- Throws:
AuthenticationException
- Invalid sessionWebserviceException
- Error in the webservicePersistenceException
- Error in the database
-
listAttributeSets
public WSAttributeSet[] listAttributeSets(String sid) throws AuthenticationException, WebserviceException, PersistenceException Description copied from interface:DocumentMetadataService
Gets metadata of all existing attribute sets.- Specified by:
listAttributeSets
in interfaceDocumentMetadataService
- Parameters:
sid
- Session identifier- Returns:
- The list of all attribute sets
- Throws:
AuthenticationException
- Invalid sessionWebserviceException
- Error in the webservicePersistenceException
- Error in the database
-
getAttributeSet
public WSAttributeSet getAttributeSet(String sid, String name) throws AuthenticationException, WebserviceException, PersistenceException Description copied from interface:DocumentMetadataService
Gets attribute set's metadata- Specified by:
getAttributeSet
in interfaceDocumentMetadataService
- Parameters:
sid
- Session identifiername
- The attribute set's name- Returns:
- A value object containing the attribute set's metadata
- Throws:
AuthenticationException
- Invalid sessionWebserviceException
- Error in the webservicePersistenceException
- Error in the database
-
getAttributeSetById
public WSAttributeSet getAttributeSetById(String sid, long setId) throws AuthenticationException, WebserviceException, PersistenceException Description copied from interface:DocumentMetadataService
Gets attribute set's metadata- Specified by:
getAttributeSetById
in interfaceDocumentMetadataService
- Parameters:
sid
- Session identifiersetId
- The attribute set's id- Returns:
- A value object containing the attribute set's metadata
- Throws:
AuthenticationException
- Invalid sessionWebserviceException
- Error in the webservicePersistenceException
- Error in the database
-
storeAttributeSet
public long storeAttributeSet(String sid, WSAttributeSet attributeSet) throws WebserviceException, PersistenceException Description copied from interface:DocumentMetadataService
Create/Update an attribute set. You can completely customize the attribute set through a value object containing the attribute set's metadata.- Specified by:
storeAttributeSet
in interfaceDocumentMetadataService
- Parameters:
sid
- Session identifier (need to be administrator)attributeSet
- set's value object containing the attribute set's metadata- Returns:
- The ID of the new attribute set
- Throws:
WebserviceException
- Error in the webservicePersistenceException
- Error in the database
-
deleteAttributeSet
public void deleteAttributeSet(String sid, long setId) throws WebserviceException, PersistenceException Description copied from interface:DocumentMetadataService
Deletes an existing attribute set with the given identifier.- Specified by:
deleteAttributeSet
in interfaceDocumentMetadataService
- Parameters:
sid
- Session identifier (need to be administrator)setId
- The attribute set's id- Throws:
WebserviceException
- Error in the webservicePersistenceException
- Error in the database
-
isTemplateReadable
public boolean isTemplateReadable(String sid, long templateId) throws AuthenticationException, WebserviceException, PersistenceException Description copied from interface:DocumentMetadataService
Tests if a template is readable.- Specified by:
isTemplateReadable
in interfaceDocumentMetadataService
- Parameters:
sid
- Session identifiertemplateId
- The template id- Returns:
- True if the identifier denotes a readable template, otherwise false.
- Throws:
AuthenticationException
- Invalid sessionWebserviceException
- Error in the webservicePersistenceException
- Error in the database
-
isTemplateWritable
public boolean isTemplateWritable(String sid, long templateId) throws AuthenticationException, WebserviceException, PersistenceException Description copied from interface:DocumentMetadataService
Tests if a template is writable- Specified by:
isTemplateWritable
in interfaceDocumentMetadataService
- Parameters:
sid
- Session identifiertemplateId
- The template id- Returns:
- True if the identifier denotes a writable template, otherwise false
- Throws:
AuthenticationException
- Invalid sessionWebserviceException
- Error in the webservicePersistenceException
- Error in the database
-
grantUserToTemplate
public void grantUserToTemplate(String sid, long templateId, long userId, int permissions) throws AuthenticationException, PermissionException, PersistenceException, WebserviceException Description copied from interface:DocumentMetadataService
Grants user permission to the template.- Specified by:
grantUserToTemplate
in interfaceDocumentMetadataService
- Parameters:
sid
- Session identifiertemplateId
- Template iduserId
- User Idpermissions
- the permission integer representation. If '0', the user will be not granted to access the template.- Throws:
AuthenticationException
- Invalid sessionPermissionException
- The permission has not been grantedPersistenceException
- Error in the databaseWebserviceException
- Error in the webservice
-
grantGroupToTemplate
public void grantGroupToTemplate(String sid, long templateId, long groupId, int permissions) throws AuthenticationException, PermissionException, WebserviceException, PersistenceException Description copied from interface:DocumentMetadataService
Grants group permission to the template.- Specified by:
grantGroupToTemplate
in interfaceDocumentMetadataService
- Parameters:
sid
- Session identifiertemplateId
- Template idgroupId
- Group Idpermissions
- the permission integer representation. If '0', the group will be not granted to access the template.- Throws:
AuthenticationException
- Invalid sessionPermissionException
- The permission has not been grantedWebserviceException
- Error in the webservicePersistenceException
- Error in the database
-
getGrantedUsers
public WSRight[] getGrantedUsers(String sid, long groupId) throws AuthenticationException, PermissionException, WebserviceException, PersistenceException Description copied from interface:DocumentMetadataService
Retrieves the list of granted users for the given template.- Specified by:
getGrantedUsers
in interfaceDocumentMetadataService
- Parameters:
sid
- Session identifiergroupId
- Template id- Returns:
- 'error' if error occurred, the right objects collection.
- Throws:
AuthenticationException
- Invalid sessionPermissionException
- The permission has not been grantedWebserviceException
- Error in the webservicePersistenceException
- Error in the database
-
getGrantedGroups
public WSRight[] getGrantedGroups(String sid, long groupId) throws AuthenticationException, PermissionException, WebserviceException, PersistenceException Description copied from interface:DocumentMetadataService
Retrieves the list of granted groups for the given template- Specified by:
getGrantedGroups
in interfaceDocumentMetadataService
- Parameters:
sid
- Session identifiergroupId
- Template id- Returns:
- 'error' if error occurred, the right objects collection
- Throws:
AuthenticationException
- Invalid sessionPermissionException
- The permission has not been grantedWebserviceException
- Error in the webservicePersistenceException
- Error in the database
-
addAttributeOption
public void addAttributeOption(String sid, long setId, String attribute, WSAttributeOption wsoption) throws AuthenticationException, WebserviceException, PersistenceException Description copied from interface:DocumentMetadataService
Add a new option for the given attribute- Specified by:
addAttributeOption
in interfaceDocumentMetadataService
- Parameters:
sid
- Session identifiersetId
- Attribute set IDattribute
- Attribute namewsoption
- Attribute option- Throws:
AuthenticationException
- Invalid sessionWebserviceException
- Error in the webservicePersistenceException
- Error in the database
-