Visit Platform at http://www.platform.com

Platform Symphony 5.0 Java API Reference

com.platform.symphony.symexec
Interface ExecutionStatus


public interface ExecutionStatus

Allows access to the status of an executed command.

See Also:
ExecutionSession

Method Summary
 SoamException getException()
          Retrieves the attached exception if the Command was unsuccessful.
 int getExitCode()
          The exit code of the Command.
 java.lang.String getId()
          Returns the identifier for the Command associated with this status.
 boolean isSuccessful()
          Indicates whether the corresponding Command was successfully processed by the middleware.
 

Method Detail

getId

java.lang.String getId()
                       throws SoamException
Returns the identifier for the Command associated with this status. This identifier is actually the TaskID assigned within symphony to this command.

Returns:
The identifier for the Command
Throws:
SoamException

isSuccessful

boolean isSuccessful()
                     throws SoamException
Indicates whether the corresponding Command was successfully processed by the middleware.

Returns:
true if the task was successfully processed, false otherwise.
Throws:
SoamException

getException

SoamException getException()
                           throws SoamException
Retrieves the attached exception if the Command was unsuccessful.

If the Command succeeded and this method is called, an exception will be thrown. Avoid erroneously calling this method by invoking ExecutionStatus#isSuccessful to verify that the Command had failed.

Returns:
The exception object generated by the middleware.
Throws:
SoamException
See Also:
isSuccessful()

getExitCode

int getExitCode()
                throws SoamException
The exit code of the Command.

Returns:
the exit code of the Command if it was successfully processed.
Throws:
SoamException

Version 5.0
Date Modified: -DREL_DATE=Nov 11 2009
Platform Computing. Accelerating Intelligence(TM).
Copyright (C) 2001-2009 Platform Computing Corporation. All rights reserved.