Class RestDocumentMetadataService

    • Constructor Detail

      • RestDocumentMetadataService

        public RestDocumentMetadataService()
    • Method Detail

      • setAttributeOptions

        @PUT
        @Path("/setAttributeOptions")
        public void setAttributeOptions​(@QueryParam("setId")
                                        long setId,
                                        @QueryParam("attribute")
                                        String attribute,
                                        @QueryParam("options")
                                        WSAttributeOption[] options)
                                 throws Exception
        Description copied from interface: DocumentMetadataService
        Saves the options for the given attribute
        Specified by:
        setAttributeOptions in interface DocumentMetadataService
        Parameters:
        setId - The attribute set's id
        attribute - The attribute's name
        options - The attribute's options
        Throws:
        Exception - error in the server application
      • storeAttributeSet

        @POST
        @Path("/storeAttributeSet")
        public long storeAttributeSet​(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 interface DocumentMetadataService
        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

        @POST
        @Path("/storeTemplate")
        public long storeTemplate​(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 interface DocumentMetadataService
        Parameters:
        template - value object containing the template's metadata
        Returns:
        The ID of the new template
        Throws:
        Exception - error in the server application
      • getTemplateById

        @GET
        @Path("/getTemplateById")
        public WSTemplate getTemplateById​(@QueryParam("templateId")
                                          long templateId)
                                   throws Exception
        Description copied from interface: DocumentMetadataService
        Gets template's metadata
        Specified by:
        getTemplateById in interface DocumentMetadataService
        Parameters:
        templateId - The template's id
        Returns:
        A value object containing the template's metadata
        Throws:
        Exception - error in the server application
      • getAttributeOptions

        @GET
        @Path("/getAttributeOptions")
        public String[] getAttributeOptions​(@QueryParam("setId")
                                            long setId,
                                            @QueryParam("attribute")
                                            String attribute)
                                     throws Exception
        Description copied from interface: DocumentMetadataService
        Retrieves the options for the given attribute
        Specified by:
        getAttributeOptions in interface DocumentMetadataService
        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
      • deleteAttributeSet

        @DELETE
        @Path("/deleteAttributeSet")
        public void deleteAttributeSet​(@QueryParam("setId")
                                       long setId)
                                throws Exception
        Description copied from interface: DocumentMetadataService
        Deletes an existing attribute set with the given identifier.
        Specified by:
        deleteAttributeSet in interface DocumentMetadataService
        Parameters:
        setId - The attribute set's id
        Throws:
        Exception - error in the server application
      • deleteTemplate

        @DELETE
        @Path("/deleteTemplate")
        public void deleteTemplate​(@QueryParam("templateId")
                                   long templateId)
                            throws Exception
        Description copied from interface: DocumentMetadataService
        Deletes an existing template with the given identifier
        Specified by:
        deleteTemplate in interface DocumentMetadataService
        Parameters:
        templateId - The template's id
        Throws:
        Exception - error in the server application
      • setAttributeOptionsPOST

        @POST
        @Path("/setAttributeOptionsPOST")
        public void setAttributeOptionsPOST​(@FormParam("setId")
                                            long setId,
                                            @FormParam("attribute")
                                            String attribute,
                                            @FormParam("values")
                                            WSAttributeOption[] options)
                                     throws Exception
        Description copied from interface: DocumentMetadataService
        Saves the options for the given attribute with a POST method. This is useful for very large lists of values
        Specified by:
        setAttributeOptionsPOST in interface DocumentMetadataService
        Parameters:
        setId - The attribute set's id
        attribute - The attribute's name
        Throws:
        Exception - error in the server application