the operation is critical - meaning if it fails the entire operation fails and the undo methods should be called.
The list of all files that have been created by the service function
The list of files that will be cleaned during an undo operation.
The operation has completed and results are ready, this callback is invoked to inform the caller of executeOperation, that the operation is done.
the result from the operation
The full list of operation results
The status of the operation
A string describing what is currently happening in the operation e.g. "Submitted job..."
Traverses the results chain and prints results and gives overall failure status
Accessor method to obtain all the files created using the file creator service
Accessor method to obtain all the files created that are marked as delete on undo
Get the operation name for display and other purposes
Accessor method for operation result
: The operation result
Append an additional message to the result message buffer
Determine if the operation failed
: If the operation failed
Accessor method for operation status
: The operation status/ stage name e.g. FAILED
Add a file created by the operation to the list of all files created and optionally mark this file as undoable, which will cause the undo operation to attempt to remove the file or directory.
Add the result to the end of the results list
Use this method to create files and optionally push them onto the files created stack that will be referenced when an undo is required.
Method that is called after the implementing classes undo to delete all the files that have been saved during the operation (on the mFilesForUndo list).
The execute method must be implemented by the class. This is where the operation performs its work and sets the result and the course of action (failed, undo possible, etc).
Execute the operation. Set the status of the operation to IN_PROGRESS and invoke the implemented operations execute method.
This method logs a standard header for the operation
This method logs a standard header for the operation
Override this method when implementing and place any operation start messages that should be logged here.
Override this method when implementing and place any operation end messages that should be logged here.
Operation complete callback method. The operation must invoke the callback to indicate that it has finished. If it does not, the operation sequence will not continue.
The perform undo method sets that an attempt was made to perform the undo and invokes the undo method of the implemented operation.
Before invoking, any files that have been created and saved on the undo-able list will be cleaned.
Method to print all the files created by the file creator service.
If the operation decides that a different path is required. You can set the next operation to complete and whether or not you should continue down the original path
Set method to indicate that the operation failed.
Set the operation undo attempted (whether it succeed or failed is up to the undo method to set)
Set that the operation undo failed. This is for diagnostic purposes.
Set method to indicate that the operation is "undoable".
This means that if an operation fails, we will 'rollback' through the completed operations and undo any that have occurred.
Set the status message for the operation
the message, including any templates you want replaced like %s or "{{myObject}}"
variable args as allowed by printf-like syntax or {myObject: this.myObject}
the final translated and formatted string (in case you want to log it etc.)
The undo method is called when an operation fails and the operation is set to "undoable"
The operation undo complete callback method, this must be called by the operations undo method in order for the operation 'undos' to continue.
Generated using TypeDoc
Action constructor to build action object