\Aculab\WebServicesWrapperRestInterruptResult

REST Interrupt result.

Returned by \Aculab\WebServicesWrapper\RestInterruptWebService::interruptApplication().

Summary

Methods
Properties
Constants
getResult()
getInterruptedAction()
No public properties found
INTERRUPTED
NO_SUCH_APPLICATION
APPLICATION_ALREADY_COMPLETED
FAILED
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Constants

INTERRUPTED

INTERRUPTED

Application interrupted.

The application instance was interrupted.

NO_SUCH_APPLICATION

NO_SUCH_APPLICATION

No such application.

An application with the given instance ID does not exist. Perhaps it completed some time ago.

APPLICATION_ALREADY_COMPLETED

APPLICATION_ALREADY_COMPLETED

Application already completed.

No action was interrupted because the application has recently completed.

FAILED

FAILED

Failed.

The attempt to interrupt the application failed.

Methods

getResult()

getResult() : string

Get the result of the interruption.

Returns one of the constants.

Returns

string

getInterruptedAction()

getInterruptedAction() : string

Get the interrupted action.

Gets the action that was interrupted, when the result is INTERRUPTED. Otherwise, an empty string is returned.

Returns

string