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

Interface IGPModifiableActivity

All Superinterfaces:

IGPActivity, IGPDevelopmentObject, IGPModifiableDevelopmentObject

All Known Subinterfaces:

IGPModifiableAction, IGPModifiableBlock, IGPModifiableProcess

public interface IGPModifiableActivity

extends IGPModifiableDevelopmentObject, IGPActivity

Represents a generic step from a process workflow. It can be an action, block or a whole process.

Method Summary

IGPAdhocActivity	addAdHocActivity(IGPModifiableActivity activityObject) Add a reference to the given ActvityObject in the current activity.
IGPAttachment	addAttachment(String displayName, String originalFileName, String handlerName, String creator, byte[] content) Adds a new attachment to the list.
void	addAttachmentId(String id) Deprecated. use addAttachment() instead. This method will be removed from future releases!
IGPInfoCallableObject	addInfoCallableObject(IGPCallableObject infoObject) Adds a InfoCallable Object to the given activity
boolean	isPersisted() Returns true if the object exists in the database, false otherwise.
void	removeAdHocActivity(IGPAdhocActivity adhocActivity) remove the reference corresponding to the given reference number from the activity
void	removeAttachment(String attachmentId) Removes an attachment object from the list.
void	removeInfoCallableObject(IGPInfoCallableObject infoCallableObject) remove the reference corresponding to the given reference number from the activity
void	setAttachmentIdList(String[] list) Deprecated. directory modify IGPModifiableActivity.getAttachmentList() instead. This method will be removed from future releases!
void	setInputMappingGroup(IGPMappingGroup mappingGroup) Specify mapping from input parameters to local parameters.
void	setLocalParameters(IGPStructureInfo structureInfo) Set the local parameters structure.
void	setOutputMappingGroup(IGPMappingGroup mappingGroup) Specify mapping from local parameters to output parameters.

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, getID, getInputParameters, getMetadata, getOriginalLocale, getOutputParameters, getPermissions, getStatus, getTitle, getType, getVersionNumber, resolveDescription, resolveTitle

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

Method Detail

setInputMappingGroup

public void setInputMappingGroup(IGPMappingGroup mappingGroup)
                          throws GPInvocationException,
                                 GPEngineException

Specify mapping from input parameters to local parameters. Call this method after making changes on the input mapping instance. To obtain an instance of IGPMappingGroup use getInputMappingGroup().

Parameters:

mappingGroup - the mapping to apply

Throws:

GPInvocationException

GPEngineException

setOutputMappingGroup

public void setOutputMappingGroup(IGPMappingGroup mappingGroup)
                           throws GPInvocationException,
                                  GPEngineException

Specify mapping from local parameters to output parameters. Call this method after making changes on the output mapping instance. To obtain an instance of IGPMappingGroup use getOutputMappingGroup().

Parameters:

mappingGroup - the mapping to apply

Throws:

GPInvocationException

GPEngineException

setLocalParameters

public void setLocalParameters(IGPStructureInfo structureInfo)
                        throws GPEngineException,
                               GPInvocationException

Set the local parameters structure. Call this method after making changes on the local structure instance. To obtain an instance of IGPStructureInfo use getLocalParameters().

Parameters:

structureInfo - root of local parameters

Throws:

GPEngineException

GPInvocationException

isPersisted

public boolean isPersisted()
                    throws GPEngineException

Returns true if the object exists in the database, false otherwise.

Returns:

Throws:

EngineException

GPEngineException

setAttachmentIdList

public void setAttachmentIdList(String[] list)

Deprecated. directory modify IGPModifiableActivity.getAttachmentList() instead. This method will be removed from future releases!

Set new attachment id list.

Parameters:

list - list containing ID of type String

addAttachmentId

public void addAttachmentId(String id)

Deprecated. use addAttachment() instead. This method will be removed from future releases!

Add new attachment id to the list.

Parameters:

id - new ID

addAttachment

public IGPAttachment addAttachment(String displayName,
                                   String originalFileName,
                                   String handlerName,
                                   String creator,
                                   byte[] content)
                            throws GPInvocationException,
                                   GPEngineException

Adds a new attachment to the list. It is up to the implementation of the attachment list for the specific store to determine whether or not it is necessary to immediately store the attachment in the database or whether or not it is stored in memory.

Parameters:

displayName - the display name of the attachment.

originalFileName - the original file name of the attchment.

handlerName - the name of the attachment handler.

creator - the unique id of the creator.

content - the actual content of the attachment.

Returns:

a reference to the new attachment object.

Throws:

InvocationException - if any of the parameters passed is invalid.

EngineException - if an error occurs while creating the attachment.

GPInvocationException

GPEngineException

See Also:

com.sap.caf.eu.gp.attachment.api.IAttachment

removeAttachment

public void removeAttachment(String attachmentId)
                      throws GPInvocationException,
                             GPEngineException

Removes an attachment object from the list.

Note that the attachment may or may not be physically removed from the underlying store immediately or not. This depends on the actual details of the implementation.

Throws:

InvocationException - if no attachment with this identifier exists.

EngineException - if an error occurs while removing the attachment.

GPInvocationException

GPEngineException

addInfoCallableObject

public IGPInfoCallableObject addInfoCallableObject(IGPCallableObject infoObject)
                                            throws GPInvocationException,
                                                   GPEngineException

Adds a InfoCallable Object to the given activity

Parameters:

infoObject - the info callable object to add

Returns:

the IReference object corresponding to the created reference

Throws:

AlreadyAddedObjectException - when the object was already added.

InvocationException

EngineException

GPInvocationException

GPEngineException

addAdHocActivity

public IGPAdhocActivity addAdHocActivity(IGPModifiableActivity activityObject)
                                  throws GPInvocationException,
                                         GPEngineException

Add a reference to the given ActvityObject in the current activity.

Parameters:

activityObject - the referenced activity object

Returns:

the reference that is stored in the current activity

Throws:

AlreadyAddedObjectException - when the given was arleady added

InvocationException

EngineException

GPInvocationException

GPEngineException

removeAdHocActivity

public void removeAdHocActivity(IGPAdhocActivity adhocActivity)
                         throws GPInvocationException,
                                GPEngineException

remove the reference corresponding to the given reference number from the activity

Throws:

InvocationException

EngineException

GPInvocationException

GPEngineException

removeInfoCallableObject

public void removeInfoCallableObject(IGPInfoCallableObject infoCallableObject)
                              throws GPInvocationException,
                                     GPEngineException

remove the reference corresponding to the given reference number from the activity

Throws:

InvocationException

EngineException

GPInvocationException

GPEngineException