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

Main Page   Class Hierarchy   Compound List   Compound Members  

ExecutionStatus Class Reference

Allows access to the status of an executed command. More...

List of all members.


Public Methods

const char * getId (void) const throw (SoamException)
 Returns the identifier for the Command associated with this status.

bool isSuccessful (void) const throw (SoamException)
 Indicates whether the corresponding Command was successfully processed by the middleware.

SoamExceptiongetException () const throw (SoamException)
 Retrieves the attached exception if the Command was unsuccessful.

int getExitCode (void) const throw (SoamException)
 The exit code of the Command.


Detailed Description

Allows access to the status of an executed command.

See also:
ExecutionSession


Member Function Documentation

const char* getId void    const throw (SoamException)
 

Returns the identifier for the Command associated with this status.

Returns:
The identifier for the Command
Exceptions:
SoamException 

bool isSuccessful void    const throw (SoamException)
 

Indicates whether the corresponding Command was successfully processed by the middleware.

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

SoamException* getException   const throw (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.
Exceptions:
SoamException 
See also:
ExecutionStatus::isSuccessful

int getExitCode void    const throw (SoamException)
 

The exit code of the Command.

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


     
Date Modified: 11 Nov 2009
Platform Support: support@platform.com
Platform Information Development: doc@platform.com

Platform Computing. Accelerating Intelligence(TM).
Copyright © 2001-2009 Platform Computing Corporation. All rights reserved.