Interface IBmBlobExporter

  • All Known Implementing Classes:
    BaseBmBlobExporter, BinaryDataExporter

    public interface IBmBlobExporter
    Components responsible for exporting blobs (or rather object changes) to workspace files. Which files blobs are exported to depends on implementations.
    • Method Detail

      • supports

        boolean supports​(String fqn)
        Checks if the exporter supports the blob with the specified FQN.
        Parameters:
        fqn - The FQN to check. May not be null.
        Returns:
        true if the exporter supports the blob with the specified FQN, false otherwise.
      • saveFile

        BmFileSaveResult saveFile​(IDtProject project,
                                  IBmNamespace namespace,
                                  String fqn,
                                  String type)
                           throws org.eclipse.core.runtime.CoreException
        Exports the specified blob and saves it in the corresponding workspace file(s) as a response to the blob's creation or modification.
        Parameters:
        project - The project the blob belongs to. May not be null.
        namespace - The namespace the blob belongs to. May not be null.
        fqn - The FQN of the blob. May not be null.
        type - The type of the blob. May not be null.
        Returns:
        an instance of BmFileSaveResult containing information about the saved file(s).
        Throws:
        org.eclipse.core.runtime.CoreException - if an error occurs.
      • deleteFile

        BmFileDeletionResult deleteFile​(IDtProject project,
                                        IBmNamespace namespace,
                                        String fqn,
                                        String type)
                                 throws org.eclipse.core.runtime.CoreException
        Deletes the file(s) the blob is saved in as a response to the blob's deletion.
        Parameters:
        project - The project the blob belongs to. May not be null.
        namespace - The namespace the blob belongs to. May not be null.
        fqn - The FQN of the blob. May not be null.
        type - The type of the blob. May not be null.
        Returns:
        an instance of BmFileDeletionResult containing information about the deleted file(s).
        Throws:
        org.eclipse.core.runtime.CoreException - if an error occurs.