Package com.logicaldoc.webservice.soap
Interface DocumentMetadataService
- All Known Implementing Classes:
RestDocumentMetadataService
,RestDocumentMetadataSwagger
,SoapDocumentMetadataClient
,SoapDocumentMetadataService
public interface DocumentMetadataService
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addAttributeOption
(String sid, long setId, String attribute, WSAttributeOption option) 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 identifiergetAccessControlList
(String sid, long templateId) Retrieves the access control listgetAttributeOptions
(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 metadatagetTemplate
(String sid, String name) Gets template's metadatagetTemplateById
(String sid, long templateId) Gets template's metadataboolean
isReadable
(String sid, long templateId) Tests if a template is readable.boolean
isWritable
(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
setAccessControlList
(String sid, long templateId, List<WSAccessControlEntry> acl) Sets the Access Control Listvoid
setAttributeOptions
(String sid, long setId, String attribute, List<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.
-
Method Details
-
listTemplates
List<WSTemplate> listTemplates(String sid) throws AuthenticationException, WebserviceException, PersistenceException Gets metadata of all existing templates.- Parameters:
sid
- Session identifier- Returns:
- The list of all templates
- Throws:
PersistenceException
- Error in the databaseWebserviceException
- Error in the webserviceAuthenticationException
- Invalid session
-
getTemplate
WSTemplate getTemplate(String sid, String name) throws AuthenticationException, WebserviceException, PersistenceException Gets template's metadata- Parameters:
sid
- Session identifiername
- The template's name- Returns:
- A value object containing the template's metadata.
- Throws:
PersistenceException
- Error in the databaseWebserviceException
- Error in the webserviceAuthenticationException
- Invalid sessionon
-
getTemplateById
WSTemplate getTemplateById(String sid, long templateId) throws AuthenticationException, WebserviceException, PersistenceException Gets template's metadata- Parameters:
sid
- Session identifiertemplateId
- The template's id- Returns:
- A value object containing the template's metadata
- Throws:
PersistenceException
- Error in the databaseWebserviceException
- Error in the webserviceAuthenticationException
- Invalid session
-
storeTemplate
long storeTemplate(String sid, WSTemplate template) throws AuthenticationException, WebserviceException, PersistenceException, PermissionException Create/Update a template. You can completely customize the template through a value object.- Parameters:
sid
- Session identifier (need to be administrator)template
- value object containing the template's metadata- Returns:
- The ID of the new template
- Throws:
PermissionException
- The permission has not been grantedPersistenceException
- Error in the databaseWebserviceException
- Error in the webserviceAuthenticationException
- Invalid session
-
deleteTemplate
void deleteTemplate(String sid, long templateId) throws AuthenticationException, WebserviceException, PersistenceException, PermissionException Deletes an existing template with the given identifier- Parameters:
sid
- Session identifier (need to be administrator)templateId
- The template's id- Throws:
PermissionException
- The permission has not been grantedPersistenceException
- Error in the databaseWebserviceException
- Error in the webserviceAuthenticationException
- Invalid session
-
listAttributeSets
List<WSAttributeSet> listAttributeSets(String sid) throws AuthenticationException, WebserviceException, PersistenceException Gets metadata of all existing attribute sets.- Parameters:
sid
- Session identifier- Returns:
- The list of all attribute sets
- Throws:
PersistenceException
- Error in the databaseWebserviceException
- Error in the webserviceAuthenticationException
- Invalid session
-
getAttributeSet
WSAttributeSet getAttributeSet(String sid, String name) throws AuthenticationException, WebserviceException, PersistenceException Gets attribute set's metadata- Parameters:
sid
- Session identifiername
- The attribute set's name- Returns:
- A value object containing the attribute set's metadata
- Throws:
PersistenceException
- Error in the databaseWebserviceException
- Error in the webserviceAuthenticationException
- Invalid session
-
getAttributeSetById
WSAttributeSet getAttributeSetById(String sid, long setId) throws AuthenticationException, WebserviceException, PersistenceException Gets attribute set's metadata- Parameters:
sid
- Session identifiersetId
- The attribute set's id- Returns:
- A value object containing the attribute set's metadata
- Throws:
PersistenceException
- Error in the databaseWebserviceException
- Error in the webserviceAuthenticationException
- Invalid session
-
storeAttributeSet
long storeAttributeSet(String sid, WSAttributeSet attributeSet) throws WebserviceException, PersistenceException Create/Update an attribute set. You can completely customize the attribute set through a value object containing the attribute set's metadata.- 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:
PersistenceException
- Error in the databaseWebserviceException
- Error in the webservice
-
deleteAttributeSet
Deletes an existing attribute set with the given identifier.- Parameters:
sid
- Session identifier (need to be administrator)setId
- The attribute set's id- Throws:
PersistenceException
- Error in the databaseWebserviceException
- Error in the webservice
-
setAttributeOptions
void setAttributeOptions(String sid, long setId, String attribute, List<WSAttributeOption> options) throws WebserviceException, PersistenceException Saves the options for the given attribute- Parameters:
sid
- Session identifiersetId
- The attribute set's idattribute
- The attribute's nameoptions
- The attribute's options- Throws:
PersistenceException
- Error in the databaseWebserviceException
- Error in the webservice
-
getAttributeOptions
List<String> getAttributeOptions(String sid, long setId, String attribute) throws AuthenticationException, WebserviceException, PersistenceException Retrieves the options for the given attribute- Parameters:
sid
- Session identifiersetId
- The attribute set's idattribute
- The attribute's name- Returns:
- the list of all the attribute's options
- Throws:
PersistenceException
- Error in the databaseWebserviceException
- Error in the webserviceAuthenticationException
- Invalid session
-
getAttributeOptionsByCategory
List<WSAttributeOption> getAttributeOptionsByCategory(String sid, long setId, String attribute, String category) throws AuthenticationException, WebserviceException, PersistenceException Retrieves the options for the given attribute inside a given category- 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:
PersistenceException
- Error in the databaseWebserviceException
- Error in the webserviceAuthenticationException
- Invalid session
-
isReadable
boolean isReadable(String sid, long templateId) throws AuthenticationException, WebserviceException, PersistenceException Tests if a template is readable.- Parameters:
sid
- Session identifiertemplateId
- The template id- Returns:
- True if the identifier denotes a readable template, otherwise false.
- Throws:
PersistenceException
- Error in the databaseWebserviceException
- Error in the webserviceAuthenticationException
- Invalid session
-
isWritable
boolean isWritable(String sid, long templateId) throws AuthenticationException, WebserviceException, PersistenceException Tests if a template is writable- Parameters:
sid
- Session identifiertemplateId
- The template id- Returns:
- True if the identifier denotes a writable template, otherwise false
- Throws:
PersistenceException
- Error in the databaseWebserviceException
- Error in the webserviceAuthenticationException
- Invalid session
-
setAccessControlList
void setAccessControlList(String sid, long templateId, List<WSAccessControlEntry> acl) throws PersistenceException, PermissionException, AuthenticationException, WebserviceException Sets the Access Control List- Parameters:
sid
- Session identifiertemplateId
- Template idacl
- the complete Access Control List- Throws:
PersistenceException
- Error in the databaseWebserviceException
- Error in the webserviceAuthenticationException
- Invalid sessionPermissionException
- The user does not have the required permission
-
getAccessControlList
List<WSAccessControlEntry> getAccessControlList(String sid, long templateId) throws AuthenticationException, WebserviceException, PersistenceException, PermissionException Retrieves the access control list- Parameters:
sid
- Session identifiertemplateId
- Template id- Returns:
- 'error' if error occurred, the right objects collection
- Throws:
PermissionException
- The permission has not been grantedPersistenceException
- Error in the databaseWebserviceException
- Error in the webserviceAuthenticationException
- Invalid session
-
addAttributeOption
void addAttributeOption(String sid, long setId, String attribute, WSAttributeOption option) throws AuthenticationException, WebserviceException, PersistenceException Add a new option for the given attribute- Parameters:
sid
- Session identifiersetId
- Attribute set IDattribute
- Attribute nameoption
- Attribute option- Throws:
AuthenticationException
- Invalid sessionWebserviceException
- Error in the webservicePersistenceException
- Error in the database
-