com.sap.caf.eu.gp.process.api

Interface IGPExceptionHandler

All Superinterfaces:
IGPObjectReference

public interface IGPExceptionHandler
extends IGPObjectReference

Reference to activity which has to be executed in case of a process exception.

Version:
0.1

Method Summary
 boolean exceptionHandlerIsAction()
          Returns true, if the exception handler is an action, false otherwise.
 IGPModifiableActivity getActivity()
          Returns the exception handler action.
 IGPModifiableBlockStructureItem getBlockItem()
          Returns the internal id of the block structure item.
 GPExceptionHandlingStrategy getExceptionHandlingStrategy()
          Returns the exception handling strategy associated with the given exception handler.
 IGPExceptionInfo getProcessException()
          Returns the name of the exception.
 IGPModifiableRoleInfo getProcessRole(String techname)
          Returns the process role associated with the given exception handler and the given technical name; may return null, if the handler is a block.
 Iterator getProcessRoles()
           
 void setExceptionHandlingStrategy(GPExceptionHandlingStrategy strategy)
          Sets the exception handling strategy associated with the given exception handler.
 
Methods inherited from interface com.sap.caf.eu.gp.base.api.IGPObjectReference
getInputMapping, getOutputMapping, getReferencedObject, setInputMapping, setOutputMapping
 

Method Detail

getProcessException

IGPExceptionInfo getProcessException()
Returns the name of the exception.


getBlockItem

IGPModifiableBlockStructureItem getBlockItem()
Returns the internal id of the block structure item.


getExceptionHandlingStrategy

GPExceptionHandlingStrategy getExceptionHandlingStrategy()
Returns the exception handling strategy associated with the given exception handler.


setExceptionHandlingStrategy

void setExceptionHandlingStrategy(GPExceptionHandlingStrategy strategy)
                                  throws GPInvocationException
Sets the exception handling strategy associated with the given exception handler.

Throws:
GPInvocationException

exceptionHandlerIsAction

boolean exceptionHandlerIsAction()
Returns true, if the exception handler is an action, false otherwise.


getActivity

IGPModifiableActivity getActivity()
                                  throws GPEngineException,
                                         GPInvocationException
Returns the exception handler action.

Throws:
GPEngineException
GPInvocationException

getProcessRole

IGPModifiableRoleInfo getProcessRole(String techname)
Returns the process role associated with the given exception handler and the given technical name; may return null, if the handler is a block.


getProcessRoles

Iterator getProcessRoles()
Returns:
an enumeration of all the IRoleInfo defined for the exception handler.


Copyright 2009 SAP AG Complete Copyright Notice