com.ibm.are.plugin
Class ExtendedResultInfo

java.lang.Object
  extended by com.ibm.are.plugin.ResultInfo
      extended by com.ibm.are.plugin.ExtendedResultInfo

public class ExtendedResultInfo
extends ResultInfo

The ExtendedResultInfo class is used to communicate the result status of running a plugin along with additional information, such as any exception that may have occurred or any results of the plugin's verification that other plugins may want access to.

Version:
1.0
Author:
IBM

Field Summary
static java.lang.String COPYRIGHT
          Copyright for class bytecode
protected  java.lang.Throwable exception
          If an exception occurs during the running of the plugin, the exception itself may be communicated to other plugins, or ARE itself, via this field.
protected  java.lang.Object extendedInfo
          Additional information made available by the plugin for other plugins to access
 
Constructor Summary
ExtendedResultInfo(boolean successful)
          Constructs a new ExtendedResultInfo object with the specified result status
 
Method Summary
 java.lang.Throwable getException()
          Retrieves any exception associated with the result information
 java.lang.Object getExtendedInfo()
          Retrieves any additional information associated with the result
 boolean hasException()
          Answers whether or not there is an exception associated with the result information
 void setException(java.lang.Throwable exception)
          Sets an exception to associate with the result information
 void setExtendedInfo(java.lang.Object extendedInfo)
          Sets additional information associated with the result
 
Methods inherited from class com.ibm.are.plugin.ResultInfo
isSuccessful
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT
Copyright for class bytecode

See Also:
Constant Field Values

extendedInfo

protected java.lang.Object extendedInfo
Additional information made available by the plugin for other plugins to access


exception

protected java.lang.Throwable exception
If an exception occurs during the running of the plugin, the exception itself may be communicated to other plugins, or ARE itself, via this field.

Constructor Detail

ExtendedResultInfo

public ExtendedResultInfo(boolean successful)
Constructs a new ExtendedResultInfo object with the specified result status

Parameters:
successful - Whether or not the plugin completed successfully
Method Detail

getException

public java.lang.Throwable getException()
Retrieves any exception associated with the result information

Returns:
Any exception associated with the result information

setException

public void setException(java.lang.Throwable exception)
Sets an exception to associate with the result information

Parameters:
exception - The exception to set

hasException

public boolean hasException()
Answers whether or not there is an exception associated with the result information

Returns:
true if there is an associated exception, false if there is not

getExtendedInfo

public java.lang.Object getExtendedInfo()
Retrieves any additional information associated with the result

Returns:
Any additional information associated with the result

setExtendedInfo

public void setExtendedInfo(java.lang.Object extendedInfo)
Sets additional information associated with the result

Parameters:
extendedInfo - Additional information associated with the result