Differences

This shows you the differences between two versions of the page.

--- pr_methods:cancel [2023/04/05 05:52] – ↷ Links adapted because of a move operation sean
+++ pr_methods:cancel [2025/06/12 04:00] (current) – Change to AwareIM aware_support3
@@ Line 1: / Line 1: @@
-{{tag>Programmers_Reference Methods IExecutionEngine IExecutionEngine_Methods Cancel}}
+{{tag>Index Programmers_Reference Methods IProcess IProcess_Methods Cancel}}
-[<10>]
 ==== cancel () ====
 <code java>public boolean cancel ();</code>
-This method is called by the //**Aware IM**// framework when the operator sends the request to cancel the process.
+This method is called by the //**AwareIM**// framework when the operator sends the request to cancel the process.
 ===Parameters===
@@ Line 10: / Line 10: @@
 ===Returns===
-The method should return true if it allows the system to cancel the process. In this case it should set an internal flag indicating that the process has been cancelled. The execute and resume methods should periodically check this flag and if its value is true abort the execution of the process (see [[docs:3500:0300:0314_examples_of_custom_components]]). If a process is in a state that does not allow canceling, the method should return false.
+The method should return true if it allows the system to cancel the process. In this case it should set an internal flag indicating that the process has been cancelled. The execute and resume methods should periodically check this flag and if its value is true abort the execution of the process (see [[docs:3500:0300:0314]]). If a process is in a state that does not allow canceling, the method should return false.