Package com.logicaldoc.webservice.rest

Interface DocumentMetadataService

  • All Known Implementing Classes:
    RestDocumentMetadataService, RestDocumentMetadataSwagger
    @Consumes("application/json")
@Produces("application/json")
public interface DocumentMetadataService
    Document Metadata Service definition interface for REST. Alessandro Gasparini - LogicalDOC
    Since:
    8.4.2

    • Method Detail

      • setAttributeOptions

        void setAttributeOptions​(long setId,
                         String attribute,
                         String[] values)
                  throws Exception
        Saves the options for the given attribute
        Parameters:
        setId - The attribute set's id
        attribute - The attribute's name
        values - The attribute's options
        Throws:
        Exception - error in the server application

      • getAttributeOptions

        String[] getAttributeOptions​(long setId,
                             String attribute)
                      throws Exception
        Retrieves the options for the given attribute
        Parameters:
        setId - The attribute set's id
        attribute - The attribute's name
        Returns:
        the list of all the attribute's options
        Throws:
        Exception - error in the server application

      • storeAttributeSet

        long storeAttributeSet​(WSAttributeSet attributeSet)
                throws Exception
        Create/Update an attribute set. You can completely customize the attribute set through a value object containing the attribute set's metadata.
        Parameters:
        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

      • storeTemplate

        long storeTemplate​(WSTemplate template)
            throws Exception
        Create/Update a template. You can completely customize the template through a value object.
        Parameters:
        template - value object containing the template's metadata
        Returns:
        The ID of the new template
        Throws:
        Exception - error in the server application

      • getAttributeSetById

        WSAttributeSet getAttributeSetById​(long setId)
                            throws Exception
        Gets attribute set's metadata
        Parameters:
        setId - The attribute set's id
        Returns:
        A value object containing the attribute set's metadata
        Throws:
        Exception - error in the server application

      • getAttributeSet

        WSAttributeSet getAttributeSet​(String name)
                        throws Exception
        Gets attribute set's metadata
        Parameters:
        name - The attribute set's name
        Returns:
        A value object containing the attribute set's metadata
        Throws:
        Exception - error in the server application

      • getTemplate

        WSTemplate getTemplate​(String name)
                throws Exception
        Gets template's metadata
        Parameters:
        name - The template's name
        Returns:
        A value object containing the template's metadata.
        Throws:
        Exception - error in the server application

      • getTemplateById

        WSTemplate getTemplateById​(long templateId)
                    throws Exception
        Gets template's metadata
        Parameters:
        templateId - The template's id
        Returns:
        A value object containing the template's metadata
        Throws:
        Exception - error in the server application

      • listTemplates

        WSTemplate[] listTemplates()
                    throws Exception
        Gets metadata of all existing templates.
        Returns:
        The list of all templates
        Throws:
        Exception - error in the server application

      • listAttributeSets

        WSAttributeSet[] listAttributeSets()
                            throws Exception
        Gets metadata of all existing attribute sets.
        Returns:
        The list of all attribute sets
        Throws:
        Exception - error in the server application

      • deleteAttributeSet

        void deleteAttributeSet​(long setId)
                 throws Exception
        Deletes an existing attribute set with the given identifier.
        Parameters:
        setId - The attribute set's id
        Throws:
        Exception - error in the server application

      • deleteTemplate

        void deleteTemplate​(long templateId)
             throws Exception
        Deletes an existing template with the given identifier
        Parameters:
        templateId - The template's id
        Throws:
        Exception - error in the server application