Interface FileImporter

    • Method Detail

      • getName

        String getName()
        Gets the plugin name.
        Returns:
        a string holding the plugin name
      • getDocType

        String getDocType()
        Returns the document type configured for this FileImporter, null if no document type is configured.
        Since:
        5.5
      • setDocType

        void setDocType​(String docType)
        Sets the document type configured for this importer.

        Since:
        5.5
      • getFilters

        List<String> getFilters()
        Gets filters.

        The filters are all the mime/type this plugin can deal with.

        Returns:
        list of string holding each filters.
      • setName

        void setName​(String name)
        Sets plugin name.
        Parameters:
        name - a string holding the name
      • setFilters

        void setFilters​(List<String> filters)
        Sets filters.

        The filters are all the mime/types this plugin can deal with.

        Parameters:
        filters - a list of strings representing each filter
      • setFileManagerService

        @Deprecated
        void setFileManagerService​(FileManagerService fileManagerService)
        Deprecated.
        since 10.3, use Framework.getService(Class) instead if needed
        Embeds a reference to the holding FileManagerService instance to be able to reuse generic file creation utility methods in specific plugin implementations.
        Parameters:
        fileManagerService - instance where the Plugin is registered as a contribution
      • matches

        boolean matches​(String mimeType)
        Tests whether plugin is suitable for the given mimetype.
        Parameters:
        mimeType - the mimetype to test
      • isEnabled

        boolean isEnabled()
      • setEnabled

        void setEnabled​(boolean enabled)
      • getOrder

        Integer getOrder()
        Returns the plugin order for sorting.
      • setOrder

        void setOrder​(Integer order)
        Sets the plugin order for sorting.