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

Interface IGPAction

All Superinterfaces:

IGPActivity, IGPDevelopmentObject

All Known Subinterfaces:

IGPModifiableAction

public interface IGPAction
extends IGPActivity

Method Summary

long	getDuration() Returns the duration associated with an action; if no duration is specified the method returns IActionTemplate.DURATION_INVALID.
IGPProcessExceptionInfo	getProcessException(String exceptionName) Returns the process exception information for the process exception with the specified name or null
int	getProcessExceptionCount() Returns the number of process exceptions.
IGPProcessExceptionInfo[]	getProcessExceptions() Returns an array of IProcessExceptionInformation - process exceptions.
IGPResultStateInfo	getResultState(String name) Returns the result state information for the result state with the specified name or null
int	getResultStateCount() Returns the number of available result states.
IGPResultStateInfo[]	getResultStates() Returns an array of IGPCOResultStateInfo - the available result states.

Methods inherited from interface com.sap.caf.eu.gp.process.api.IGPActivity

getAdhocActivities, getAssignedCategories, getAttachmentIds, getAttachments, getCreationDate, getCreator, getID, getInfoCallableObjects, getInputMappingGroup, getInputParameters, getLocalParameters, getOutputMappingGroup, getOutputParameters, getParentBlock, getParentProcess, getVersionNumber, isAction, isBlock, resolveDescription, resolveTitle

Methods inherited from interface com.sap.caf.eu.gp.base.api.IGPDevelopmentObject

getCategories, getDescription, getMetadata, getOriginalLocale, getPermissions, getStatus, getTitle, getType

Method Detail

getDuration

long getDuration()

Returns the duration associated with an action; if no duration is specified the method returns IActionTemplate.DURATION_INVALID.

Returns:

long

getResultStates

IGPResultStateInfo[] getResultStates()
                                     throws GPEngineException

Returns an array of IGPCOResultStateInfo - the available result states.

Returns:

IGPCOResultStateInfo[] NOT NULL

Throws:

GPEngineException

GPInvocationException

getResultStateCount

int getResultStateCount()
                        throws GPEngineException,
                               GPInvocationException

Returns the number of available result states.

Returns:

int

Throws:

GPEngineException

GPInvocationException

getResultState

IGPResultStateInfo getResultState(String name)
                                  throws GPEngineException,
                                         GPInvocationException

Returns the result state information for the result state with the specified name or null

Parameters:

name - String NOT NULL

Returns:

IGPCOResultStateInfo may be NULL

Throws:

GPEngineException

GPInvocationException

getProcessExceptionCount

int getProcessExceptionCount()
                             throws GPEngineException,
                                    GPInvocationException

Returns the number of process exceptions.

Returns:

int

Throws:

GPEngineException

GPInvocationException

getProcessExceptions

IGPProcessExceptionInfo[] getProcessExceptions()
                                               throws GPEngineException,
                                                      GPInvocationException

Returns an array of IProcessExceptionInformation - process exceptions.

Returns:

IProcessExceptionInformation[] NOT NULL

Throws:

GPEngineException

GPInvocationException

getProcessException

IGPProcessExceptionInfo getProcessException(String exceptionName)
                                            throws GPEngineException,
                                                   GPInvocationException

Returns the process exception information for the process exception with the specified name or null

Parameters:

exceptionName - String NOT NULL

Returns:

IProcessExceptionInformation may be NULL

Throws:

GPEngineException

GPInvocationException