org.apache.uima.aae.error
Interface ErrorResult

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
ErrorResultBaseImpl

public interface ErrorResult
extends java.io.Serializable


Method Summary
 void addComponentKeyPath(java.lang.String aComponentKeyPath)
           
 void addComponentKeyPath(java.lang.String aComponentKeyPath, boolean terminated, boolean disabled)
           
 ErrorResultComponentPath getComponentKeyPath()
          Returns a path consisting of a list of component key names
 java.lang.Throwable getRootCause()
          Returns the underlying root cause first reported as an error
 ErrorResultTDs getTDs()
          Returns a collection of paths to the components that were terminated or disabled
 void setDisabled()
           
 void setRootCause(java.lang.Throwable aRootCause)
           
 void setTerminated()
           
 boolean wasDisabled()
          Returns true if any disabling occured with this error
 boolean wasTerminated()
          Returns true is any termination occurred with this error
 

Method Detail

setRootCause

void setRootCause(java.lang.Throwable aRootCause)

addComponentKeyPath

void addComponentKeyPath(java.lang.String aComponentKeyPath)

addComponentKeyPath

void addComponentKeyPath(java.lang.String aComponentKeyPath,
                         boolean terminated,
                         boolean disabled)

setTerminated

void setTerminated()

setDisabled

void setDisabled()

getRootCause

java.lang.Throwable getRootCause()
Returns the underlying root cause first reported as an error

Returns:
Throwable

getComponentKeyPath

ErrorResultComponentPath getComponentKeyPath()
Returns a path consisting of a list of component key names

Returns:
a path consisting of a list of component key names

wasTerminated

boolean wasTerminated()
Returns true is any termination occurred with this error

Returns:
true is any termination occurred with this error

wasDisabled

boolean wasDisabled()
Returns true if any disabling occured with this error

Returns:
true if any disabling occured with this error

getTDs

ErrorResultTDs getTDs()
Returns a collection of paths to the components that were terminated or disabled

Returns:
a collection of paths to the components that were terminated or disabled


Copyright © 2012. All Rights Reserved.