Class SoapDocumentMetadataService
- java.lang.Object
-
- com.logicaldoc.webservice.AbstractService
-
- com.logicaldoc.webservice.soap.endpoint.SoapDocumentMetadataService
-
- All Implemented Interfaces:
DocumentMetadataService
- Direct Known Subclasses:
RestDocumentMetadataService
public class SoapDocumentMetadataService extends AbstractService implements DocumentMetadataService
Document Metadata Web Service Implementation- Since:
- 6.1
- Author:
- Matteo Caruso - LogicalDOC
-
-
Constructor Summary
Constructors Constructor Description SoapDocumentMetadataService()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description 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 identifierString[]
getAttributeOptions(String sid, long setId, String attribute)
Retrieves the options for the given attributeWSAttributeSet
getAttributeSet(String sid, String name)
Gets attribute set's metadataWSAttributeSet
getAttributeSetById(String sid, long setId)
Gets attribute set's metadataWSRight[]
getGrantedGroups(String sid, long templateId)
Retrieves the list of granted groups for the given templateWSRight[]
getGrantedUsers(String sid, long templateId)
Retrieves the list of granted users for the given template.WSTemplate
getTemplate(String sid, String name)
Gets template's metadataWSTemplate
getTemplateById(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 writableWSAttributeSet[]
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, String[] values)
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.-
Methods inherited from class com.logicaldoc.webservice.AbstractService
convertDateToString, convertStringToDate, getContext, getMessageContext, isValidateSession, setContext, setMessageContext, setValidateSession
-
-
-
-
Method Detail
-
listTemplates
public WSTemplate[] listTemplates(String sid) throws Exception
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:
Exception
- error in the server application
-
getTemplate
public WSTemplate getTemplate(String sid, String name) throws Exception
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:
Exception
- error in the server application
-
getTemplateById
public WSTemplate getTemplateById(String sid, long templateId) throws Exception
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:
Exception
- error in the server application
-
storeTemplate
public long storeTemplate(String sid, WSTemplate template) throws Exception
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:
Exception
- error in the server application
-
deleteTemplate
public void deleteTemplate(String sid, long templateId) throws Exception
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:
Exception
- error in the server application
-
setAttributeOptions
public void setAttributeOptions(String sid, long setId, String attribute, String[] values) throws Exception
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 namevalues
- The attribute's options- Throws:
Exception
- error in the server application
-
getAttributeOptions
public String[] getAttributeOptions(String sid, long setId, String attribute) throws Exception
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:
Exception
- error in the server application
-
listAttributeSets
public WSAttributeSet[] listAttributeSets(String sid) throws Exception
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:
Exception
- error in the server application
-
getAttributeSet
public WSAttributeSet getAttributeSet(String sid, String name) throws Exception
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:
Exception
- error in the server application
-
getAttributeSetById
public WSAttributeSet getAttributeSetById(String sid, long setId) throws Exception
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:
Exception
- error in the server application
-
storeAttributeSet
public long storeAttributeSet(String sid, WSAttributeSet attributeSet) throws Exception
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:
Exception
- error in the server application
-
deleteAttributeSet
public void deleteAttributeSet(String sid, long setId) throws Exception
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:
Exception
- error in the server application
-
isTemplateReadable
public boolean isTemplateReadable(String sid, long templateId) throws Exception
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:
Exception
- error in the server application
-
isTemplateWritable
public boolean isTemplateWritable(String sid, long templateId) throws Exception
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:
Exception
- error in the server application
-
grantUserToTemplate
public void grantUserToTemplate(String sid, long templateId, long userId, int permissions) throws Exception
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:
Exception
- error in the server application
-
grantGroupToTemplate
public void grantGroupToTemplate(String sid, long templateId, long groupId, int permissions) throws Exception
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:
Exception
- error in the server application
-
getGrantedUsers
public WSRight[] getGrantedUsers(String sid, long templateId) throws Exception
Description copied from interface:DocumentMetadataService
Retrieves the list of granted users for the given template.- Specified by:
getGrantedUsers
in interfaceDocumentMetadataService
- Parameters:
sid
- Session identifiertemplateId
- Template id- Returns:
- 'error' if error occurred, the right objects collection.
- Throws:
Exception
- error in the server application
-
getGrantedGroups
public WSRight[] getGrantedGroups(String sid, long templateId) throws Exception
Description copied from interface:DocumentMetadataService
Retrieves the list of granted groups for the given template- Specified by:
getGrantedGroups
in interfaceDocumentMetadataService
- Parameters:
sid
- Session identifiertemplateId
- Template id- Returns:
- 'error' if error occurred, the right objects collection
- Throws:
Exception
- error in the server application
-
-