*** This interface provides Binary Compatibility only, not Source Compatibility ***

com.sas.services.deployment
Interface OperationMonitorInterface

All Superinterfaces:

java.lang.Runnable

All Known Implementing Classes:

OperationMonitor

@SASScope(value="ALL")
@BinaryCompatibilityOnly
public interface OperationMonitorInterface
extends java.lang.Runnable

Interface describing how an operation can provide status information to a monitor regarding exceptions that have occurred.

Since:

1.0

Method Summary

abstract void	addThrowable(java.lang.Throwable throwable) Notify the operation monitor that an exception has occurred.
abstract java.lang.Throwable[]	getThrowables() Gets throwables which describe issues which were encountered during the operation.
abstract boolean	hasOperationCompleted() Whether or not the operation has completed its execution.
abstract boolean	isOK() Determines whether or not the monitored operation completed without encountering any issues.
abstract void	setOperationCompleted() Specifies that the operation has completed its exeuction.

Method Detail

hasOperationCompleted

boolean hasOperationCompleted()

Whether or not the operation has completed its execution.

Returns:

true if the operation has completed.

setOperationCompleted

void setOperationCompleted()

Specifies that the operation has completed its exeuction.

isOK

boolean isOK()

Determines whether or not the monitored operation completed without encountering any issues.

Returns:

true if no issues were encountered executing the operation or false if a problem was encountered. If the return value is false use getThrowables() to determine why the operation failed.

addThrowable

void addThrowable(java.lang.Throwable throwable)

Notify the operation monitor that an exception has occurred.

Parameters:

throwable - A Throwable encountered while executing the operation.

getThrowables

java.lang.Throwable[] getThrowables()

Gets throwables which describe issues which were encountered during the operation.

Returns:

Throwables encountered during the operation. A zero-length array is indicative of a successful operation.

*** This interface provides Binary Compatibility only, not Source Compatibility ***