com.sap.netweaver.coll.shared.api.extension
Interface IExtensionResult

All Superinterfaces:
IExtensionContext

public interface IExtensionResult
extends IExtensionContext

Interface describing a result of an extension. It inherits a context that transports parameter values after an extension has been processed, and adds a return code.


Field Summary
static int ERROR
           
static int OK
           
static int PARAMETER_MISSING
           
 
Method Summary
 java.lang.Exception getException()
          Get the exception if the return code is on ERROR.
 java.lang.String getMissingParameterId()
          Get the id of the parameter that is missing.
 int getReturnCode()
          Get the return code of the result.
 
Methods inherited from interface com.sap.netweaver.coll.shared.api.extension.IExtensionContext
addContext, getOptionalValue, getParameters, getValue, isReference, putValue, putValue, setReference, size
 

Field Detail

OK

public static final int OK

ERROR

public static final int ERROR

PARAMETER_MISSING

public static final int PARAMETER_MISSING
Method Detail

getReturnCode

public int getReturnCode()
Get the return code of the result. If the return code is ERROR, the result contains a parameter with id EXCEPTION to retrieve the exception that occured while the extension was processed.
Returns:
The return code

getException

public java.lang.Exception getException()
Get the exception if the return code is on ERROR.
Returns:
The Excpetion if if the return code is on ERROR, or null

getMissingParameterId

public java.lang.String getMissingParameterId()
Get the id of the parameter that is missing.
Returns:
The parameter id