Interface IBmSaveManager

  • All Known Subinterfaces:
    IBmProjectProvider

    public interface IBmSaveManager
    The save manager saves objects to external data sources.
    • Method Detail

      • addSyncListener

        void addSyncListener​(IBmWorkspaceSynchronizationListener listener)
        Addes the specified synchronization listener.
        Parameters:
        listener - The listener. May not be null.
      • removeSyncListener

        void removeSyncListener​(IBmWorkspaceSynchronizationListener listener)
        Removes the specified synchronizaton listener.
        Parameters:
        listener - The listener. May not be null.
      • save

        void save​(List<BmSaveManagerTask> tasks,
                  boolean saveSync,
                  boolean saveParallel)
        Saves objects to external data sources.
        Parameters:
        tasks - The tasks specifying which resources should be saved. May not be null.
        saveSync - true if the provider should save changes synchronously; {code false} if it could use async behavior (depends on provider)
        saveParallel - true if the provider should try to save resources in parallel; {code false} if the provider mustn't save resources in parallel.
      • setModel

        void setModel​(IBmModel model)
        Sets the model the current provider is being associated with. It's the right way of accessing the underlying model from the provider implementation.
        Parameters:
        bmModel - The instance of the BM associated with this provider. May not be null.
      • lock

        @Deprecated
        default void lock​(Object handle)
        Deprecated.
        The method was originally added to control export processes. Soon its invocations will be replaced by proper operation orchestration.
        Locks save manager activity against the given handle. Usually handle is a transaction that performs a commit at the moment. Until all locks against all handles are released - the save manager activity isn't resumed.
        Parameters:
        handle - The handle to lock the save manager activity against. May not be null.
      • unlock

        @Deprecated
        default void unlock​(Object handle)
        Deprecated.
        The method was originally added to control export processes. Soon its invocations will be replaced by proper operation orchestration.
        Unlocks the save manager activity. See lock(Object) for the details.
        Parameters:
        handle - The handle to unlock the save manager activity for. May not be null.