Package com.logicaldoc.webservice.soap

Interface DocumentMetadataService

All Known Implementing Classes:

RestDocumentMetadataService, RestDocumentMetadataSwagger, SoapDocumentMetadataClient, SoapDocumentMetadataService

public interface DocumentMetadataService

Method Summary

Modifier and Type	Method	Description
void	addAttributeOption(String sid, long setId, String attribute, WSAttributeOption option)	Add a new option for the given attribute
void	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 identifier
String[]	getAttributeOptions(String sid, long setId, String attribute)	Retrieves the options for the given attribute
WSAttributeOption[]	getAttributeOptionsByCategory(String sid, long setId, String attribute, String category)	Retrieves the options for the given attribute inside a given category
WSAttributeSet	getAttributeSet(String sid, String name)	Gets attribute set's metadata
WSAttributeSet	getAttributeSetById(String sid, long setId)	Gets attribute set's metadata
WSRight[]	getGrantedGroups(String sid, long templateId)	Retrieves the list of granted groups for the given template
WSRight[]	getGrantedUsers(String sid, long templateId)	Retrieves the list of granted users for the given template.
WSTemplate	getTemplate(String sid, String name)	Gets template's metadata
WSTemplate	getTemplateById(String sid, long templateId)	Gets template's metadata
void	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 writable
WSAttributeSet[]	listAttributeSets(String sid)	Gets metadata of all existing attribute sets.
WSTemplate[]	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 attribute
long	storeAttributeSet(String sid, WSAttributeSet attributeSet)	Create/Update an attribute set.
long	storeTemplate(String sid, WSTemplate template)	Create/Update a template.

Method Detail

listTemplates

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 database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

getTemplate

WSTemplate getTemplate(String sid,
                       String name)
                throws AuthenticationException,
                       WebserviceException,
                       PersistenceException

Gets template's metadata

Parameters:

sid - Session identifier

name - The template's name

Returns:

A value object containing the template's metadata.

Throws:

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid sessionon

getTemplateById

WSTemplate getTemplateById(String sid,
                           long templateId)
                    throws AuthenticationException,
                           WebserviceException,
                           PersistenceException

Gets template's metadata

Parameters:

sid - Session identifier

templateId - The template's id

Returns:

A value object containing the template's metadata

Throws:

PersistenceException - Error in the database

WebserviceException - Error in the webservice

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

PersistenceException - Error in the database

WebserviceException - Error in the webservice

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

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

listAttributeSets

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 database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

getAttributeSet

WSAttributeSet getAttributeSet(String sid,
                               String name)
                        throws AuthenticationException,
                               WebserviceException,
                               PersistenceException

Gets attribute set's metadata

Parameters:

sid - Session identifier

name - The attribute set's name

Returns:

A value object containing the attribute set's metadata

Throws:

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

getAttributeSetById

WSAttributeSet getAttributeSetById(String sid,
                                   long setId)
                            throws AuthenticationException,
                                   WebserviceException,
                                   PersistenceException

Gets attribute set's metadata

Parameters:

sid - Session identifier

setId - The attribute set's id

Returns:

A value object containing the attribute set's metadata

Throws:

PersistenceException - Error in the database

WebserviceException - Error in the webservice

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

WebserviceException - Error in the webservice

deleteAttributeSet

void deleteAttributeSet(String sid,
                        long setId)
                 throws WebserviceException,
                        PersistenceException

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 database

WebserviceException - Error in the webservice

setAttributeOptions

void setAttributeOptions(String sid,
                         long setId,
                         String attribute,
                         WSAttributeOption[] options)
                  throws WebserviceException,
                         PersistenceException

Saves the options for the given attribute

Parameters:

sid - Session identifier

setId - The attribute set's id

attribute - The attribute's name

options - The attribute's options

Throws:

PersistenceException - Error in the database

WebserviceException - Error in the webservice

getAttributeOptions

String[] getAttributeOptions(String sid,
                             long setId,
                             String attribute)
                      throws AuthenticationException,
                             WebserviceException,
                             PersistenceException

Retrieves the options for the given attribute

Parameters:

sid - Session identifier

setId - The attribute set's id

attribute - The attribute's name

Returns:

the list of all the attribute's options

Throws:

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

getAttributeOptionsByCategory

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 identifier

setId - The attribute set's id

attribute - The attribute's name

category - The options category (not mandatory)

Returns:

the list of all the attribute's options

Throws:

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

isTemplateReadable

boolean isTemplateReadable(String sid,
                           long templateId)
                    throws AuthenticationException,
                           WebserviceException,
                           PersistenceException

Tests if a template is readable.

Parameters:

sid - Session identifier

templateId - The template id

Returns:

True if the identifier denotes a readable template, otherwise false.

Throws:

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

isTemplateWritable

boolean isTemplateWritable(String sid,
                           long templateId)
                    throws AuthenticationException,
                           WebserviceException,
                           PersistenceException

Tests if a template is writable

Parameters:

sid - Session identifier

templateId - The template id

Returns:

True if the identifier denotes a writable template, otherwise false

Throws:

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

grantUserToTemplate

void grantUserToTemplate(String sid,
                         long templateId,
                         long userId,
                         int permissions)
                  throws PersistenceException,
                         AuthenticationException,
                         WebserviceException,
                         PermissionException

Grants user permission to the template.

Parameters:

sid - Session identifier

templateId - Template id

userId - User Id

permissions - the permission integer representation. If '0', the user will be not granted to access the template.

Throws:

PermissionException - The permission has not been granted

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

grantGroupToTemplate

void grantGroupToTemplate(String sid,
                          long templateId,
                          long groupId,
                          int permissions)
                   throws AuthenticationException,
                          WebserviceException,
                          PersistenceException,
                          PermissionException

Grants group permission to the template.

Parameters:

sid - Session identifier

templateId - Template id

groupId - Group Id

permissions - the permission integer representation. If '0', the group will be not granted to access the template.

Throws:

PermissionException - The permission has not been granted

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

getGrantedUsers

WSRight[] getGrantedUsers(String sid,
                          long templateId)
                   throws AuthenticationException,
                          WebserviceException,
                          PersistenceException,
                          PermissionException

Retrieves the list of granted users for the given template.

Parameters:

sid - Session identifier

templateId - Template id

Returns:

'error' if error occurred, the right objects collection.

Throws:

PermissionException - The permission has not been granted

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

getGrantedGroups

WSRight[] getGrantedGroups(String sid,
                           long templateId)
                    throws AuthenticationException,
                           WebserviceException,
                           PersistenceException,
                           PermissionException

Retrieves the list of granted groups for the given template

Parameters:

sid - Session identifier

templateId - Template id

Returns:

'error' if error occurred, the right objects collection

Throws:

PermissionException - The permission has not been granted

PersistenceException - Error in the database

WebserviceException - Error in the webservice

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

setId - Attribute set ID

attribute - Attribute name

option - Attribute option

Throws:

AuthenticationException - Invalid session

WebserviceException - Error in the webservice

PersistenceException - Error in the database