Required?: NO
Authenticated Request?: YES
Request Arguments: Generic Proxy Tool Request Arguments, state
Sample Implementation: StateChangeAction.java
Action on Failure return: If going to 'available' then the state change will be blocked in AS. Otherwise failure is ignored and a warning message is displayed (but the AS operation completes successfully).
Action on Communications error: Same as failure (Error logged to file).
Action when proxy tool not available: Event sent since this is a result of changing the state.
If specified then this request is called as a simple XML response method. The extra argument passed is state with one of the following values:
- available
- inactive
- unavailable
These states correspond to the three state options for the tool on the tool properties page in the academic suite UI. For inactive and unavailable, this is a purely informative step. If Blackboard Learn fails to make this call or you return a failure result then it is ignored. Conversely, the available state transition will fail if the state change operation is configured and the request fails.