Package ch.ivyteam.ivy.process.extension.impl

Class AbstractUserProcessExtension

java.lang.Object

ch.ivyteam.ivy.process.extension.impl.AbstractProcessExtension

ch.ivyteam.ivy.process.extension.impl.AbstractUserProcessExtension

All Implemented Interfaces:

IProcessExtension, IUserProcessExtension

public class AbstractUserProcessExtension
extends AbstractProcessExtension
implements IUserProcessExtension

Abstract base class that implements the IUserProcessExtension interface. Users can extends this interface to implement their process extension bean classes. This class provides a lot of useful methods that can be used to implement the IUserProcessExtension.perform(ch.ivyteam.ivy.process.engine.IRequestId, ch.ivyteam.ivy.scripting.objects.CompositeObject, ch.ivyteam.ivy.scripting.language.IIvyScriptContext) method.

Since:

28.08.2008

API:

This is a public API.

Method Summary

Modifier and Type	Method	Description
CompositeObject	perform(IRequestId requestId, CompositeObject in, IIvyScriptContext context)	This method is the program performed in a process extension element every time a token comes to the process element (request).

Methods inherited from class ch.ivyteam.ivy.process.extension.impl.AbstractProcessExtension

abort, createOwnContext, declareAndInitializeVariable, declareVariable, executeAsSystem, executeIvyScript, executeIvyScript, getAdditionalLogInfo, getCase, getConfiguration, getConfigurationProperty, getConfigurationPropertyNames, getContentManagementSystem, getExtensions, getLog, getProcessDataField, getProcessElementIdentifier, getRequest, getResponse, getServerExtension, getSession, getTask, getWf, parseIvyScript, release, setConfiguration, setProcessDataField, setVariableValue, start, stop

Methods inherited from interface ch.ivyteam.ivy.process.extension.IProcessExtension

abort, getAdditionalLogInfo, release, setConfiguration, start, stop

Method Detail

perform

public CompositeObject perform(IRequestId requestId,
                               CompositeObject in,
                               IIvyScriptContext context)
                        throws Exception

Description copied from interface: IUserProcessExtension

This method is the program performed in a process extension element every time a token comes to the process element (request). Note that more than one thread can call this method parallel if more than one request are running through the process extension element. Therefore the bean must be aware of multithreading.

Specified by:

perform in interface IUserProcessExtension

Parameters:

requestId - the identifier of the request

in - the current process data. Modify this process data in your implementation

context - the context to use to perform the request

Returns:

the process data that are reinjected to the process. Most implementation simple return the in object

Throws:

Exception - if perform fails

See Also:

IUserProcessExtension.perform(ch.ivyteam.ivy.process.engine.IRequestId, ch.ivyteam.ivy.scripting.objects.CompositeObject, ch.ivyteam.ivy.scripting.language.IIvyScriptContext)

API:

This public API is available in Java.