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

Interface IGPModifiableAction

All Superinterfaces:

IGPAction, IGPActivity, IGPDevelopmentObject, IGPModifiableActivity, IGPModifiableDevelopmentObject

public interface IGPModifiableAction
extends IGPModifiableActivity, IGPAction

An atomic step from the process workflow. The action needs a callable object in order to be executed. Optionally it can define a display callable object, which will be used to provide information about the action after it is completed. Unlike execute callable object, display callable object cannot change the state of the action i.e. to modify output parameters.

Version:

1.0

Method Summary

IGPDisplayCallableObject	getDisplayCallableObject() Get the callable object dedicated for display.
IGPExecuteCallableObject	getExecuteCallableObject() Get the callable object dedicated to execution.
IGPDisplayCallableObject	replaceDisplayCallableObject(IGPCallableObject object) Set the callable object to be used for display.
IGPExecuteCallableObject	replaceExecuteCallableObject(IGPCallableObject object) Set the callable object to be used for execution.
IGPDisplayCallableObject	setDisplayCallableObject(IGPCallableObject object) Set the callable object to be used for display.
IGPExecuteCallableObject	setExecuteCallableObject(IGPCallableObject object) Set the callable object to be used for execution.

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

addAdHocActivity, addAttachment, addAttachmentId, addInfoCallableObject, isPersisted, removeAdHocActivity, removeAttachment, removeInfoCallableObject, setAttachmentIdList, setInputMappingGroup, setLocalParameters, setOutputMappingGroup

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

addPermission, addToCategory, removeFromCategory, removePermission, removePermission, setDescription, setInputParameters, setOutputParameters, setTitle, validate

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

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

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

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

getDuration, getProcessException, getProcessExceptionCount, getProcessExceptions, getResultState, getResultStateCount, getResultStates

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

getDisplayCallableObject

IGPDisplayCallableObject getDisplayCallableObject()
                                                  throws GPEngineException

Get the callable object dedicated for display.

Returns:

the display callable object for this action

Throws:

GPEngineException

getExecuteCallableObject

IGPExecuteCallableObject getExecuteCallableObject()
                                                  throws GPEngineException

Get the callable object dedicated to execution.

Returns:

the execution callable object for this action

Throws:

GPEngineException

setDisplayCallableObject

IGPDisplayCallableObject setDisplayCallableObject(IGPCallableObject object)
                                                  throws GPEngineException,
                                                         GPInvocationException

Set the callable object to be used for display. This method deletes any previously defined mappings for display callable object.

Parameters:

object - display callable object for this action

Throws:

GPEngineException

GPInvocationException

setExecuteCallableObject

IGPExecuteCallableObject setExecuteCallableObject(IGPCallableObject object)
                                                  throws GPEngineException,
                                                         GPInvocationException

Set the callable object to be used for execution. This method deletes any previously defined mappings for execute callable object.

Parameters:

object - execution callable object for this action

Throws:

GPEngineException

GPInvocationException

replaceExecuteCallableObject

IGPExecuteCallableObject replaceExecuteCallableObject(IGPCallableObject object)
                                                      throws GPEngineException,
                                                             GPInvocationException

Set the callable object to be used for execution. This method preserves the previously done mappings.

Parameters:

object - execution callable object for this action

Throws:

GPEngineException

GPInvocationException

replaceDisplayCallableObject

IGPDisplayCallableObject replaceDisplayCallableObject(IGPCallableObject object)
                                                      throws GPEngineException,
                                                             GPInvocationException

Set the callable object to be used for display. This method preserves the previously done mappings.

Parameters:

object - display callable object for this action

Throws:

GPEngineException

GPInvocationException