class
ProjectLibraryOperation
Performs a project library operation such as save, move, copy or delete.
Operations are executed in three stages:
- Prepare (Main-thread) - Operation will ensure the input parameters are correct and return success if so. Operations will usually also register entries in the project library database at this stage (if possible). If this step fails, no further steps are executed. Since this executes on the main thread, this step should not take long so it doesn't block the UI.
- Run (Worker-thread) - This is where the bulk of the operation work will happen. Usually this involves serializing the package, writing moving, copying or deleting the file and similar.
- Finalize (Main-thread) - Triggers on the main thread after the worker thread has finished. Allows the main thread to wrap up the operation. For example this may involve refreshing the entry meta-data from the package that was saved by the worker thread.
Public
Constructors
ProjectLibraryOperation
Methods
~ProjectLibraryOperation
GetOperationTracker
Returns the tracker that should be used for notifications about operation's progress.
NotifyOperationWillStart
To be called by the operation worker just before calling PrepareOnMainThread.
NotifyOperationDidEnd
To be called by the operation worker just after calling FinalizeOnMainThread.
PrepareOnMainThread
Performs the first stage of the operation.
Verifies the input parameters are correct, creates library database entries (if possible) and returns success if operation will proceed to execute. Executed on the main thread.
Returns: Operation result and optional error message if failed.
RunOnWorkerThread
Performs the second stage of the operation.
Performs longer lasting tasks such as saving or loading a package, copying a file or generating preview icons. Executed on a worker thread.
FinalizeOnMainThread
Performs the last stage of the operation.
This will be called after the worker thread completes. Will ensure the entries in the project library database match to packages written by the worker thread.