com.appiancorp.suiteapi.process.framework

Class AbstractActivity

java.lang.Object

com.appiancorp.suiteapi.process.framework.AbstractActivity

All Implemented Interfaces:

SmartServiceContext

public abstract class AbstractActivity
extends java.lang.Object
implements SmartServiceContext

Abstract class to be subclassed when implementing a Java execution environment activity. The subclass will contain the code that actually performs the activity.

Field Summary

Fields

Modifier and Type	Field and Description
ActivityExecutionMetadata	_metadata

Constructor Summary

Constructors

Constructor and Description
AbstractActivity()

Method Summary

Modifier and Type	Method and Description
SafeActivityReturnVariable[]	execute(ActivityClassParameter[] inputs_, SafeActivityReturnVariable[] outputs_, java.lang.Object extraParameters_, ServiceContext sc_) The actual method that implements an activity.
SafeActivityReturnVariable[]	execute(ActivityClassParameter[] inputs_, SafeActivityReturnVariable[] outputs_, java.lang.Object extraParameters_, com.appiancorp.asl3.servicefw.connect.ServiceContext sc_) Deprecated. since 6.0.3; override the other execute(ActivityClassParameter[], SafeActivityReturnVariable[], Object, ServiceContext)
java.util.HashMap	getActivityMap() Retrieves the HashMap which stores key/value pairs to be used in a non-process environment after the activity executes.
java.lang.Object	getExtraParameters()
ActivityExecutionMetadata	getMetadata() Returns the metadata associated with this execution, including properties related to the Process Model and Tasks.
java.util.Locale	getPrimaryLocale() Returns the primary Locale of the Appian System.
ProcessModelProperties	getProcessModelProperties()
ProcessProperties	getProcessProperties()
TaskProperties	getTaskProperties()
User	getUser()
java.util.Locale	getUserLocale() Returns the Locale of the User executing this Smart Service.
java.lang.String	getUsername() Returns the User for whom this Smart Service is executing.
protected java.lang.Object	lookupInWebAppJndi(java.lang.String name) Deprecated. The JNDI context "comp" should not be used. Use any context that does not begin with "comp", and retrieve the object using the standard JNDI syntax: Context ctx = new InitialContext(); Object o = ctx.lookup(name);
ActivityReturnVariable[]	perform() This method is called by the framework when the activity is to be executed.
ActivityReturnVariable[]	perform(ServiceContext sc_) This method is called by the framework when the activity is to be executed.
java.lang.Long	run() Deprecated. 08-07-2006 Use perform() instead.
java.lang.Long	run(ServiceContext sc_) Deprecated. 08-07-2006 Use perform(ServiceContext) instead.
void	setActivityMap(java.util.HashMap activityMap_) Sets the HashMap for this activity.
void	setActivityProperties(ActivityProperties ap_) Convenience method to set all properties at once.
void	setExtraParameters(java.lang.Object extraParameters_)
void	setMetadata(ActivityExecutionMetadata metadata_)
void	setPrimaryLocale(java.util.Locale primaryLocale_)
void	setProcessModelProperties(ProcessModelProperties processModelProperties_)
void	setProcessProperties(ProcessProperties processProperties_)
void	setTaskProperties(TaskProperties taskProperties_)
void	setUser(User user_)
void	setUserLocale(java.util.Locale userLocale_)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

_metadata

public ActivityExecutionMetadata _metadata

Constructor Detail

AbstractActivity

public AbstractActivity()

Method Detail

perform

public final ActivityReturnVariable[] perform()
                                       throws ActivityExecutionException,
                                              java.lang.Exception

This method is called by the framework when the activity is to be executed. This method calls execute() but does not notify the process engine of success. This method is not meant to be overridden and is thus final.

Returns:

The return values from the activity.

Throws:

ActivityExecutionException - This exception contains the actual exception that occurred while executing the activity. It can also contain messages for both user and the administrator. In the case of attended activity the message for the user will be display immediately.

java.lang.Exception - If anything else goes wrong. Activities can throw any subclass of Exception. All exceptions are caught and handled higher in the framework. If an activity fails, it is necessary to throw an exception from this method so that the process engine will be alerted that the activity failed.

perform

public final ActivityReturnVariable[] perform(ServiceContext sc_)
                                       throws ActivityExecutionException,
                                              java.lang.Exception

This method is called by the framework when the activity is to be executed. This method calls execute() but does not notify the process engine of success. This method is not meant to be overridden and is thus final.

Parameters:

sc_ - ServiceContext of the user executing the activity.

Returns:

The return values from the activity.

Throws:

ActivityExecutionException - This exception contains the actual exception that occurred while executing the activity. It can also contain messages for both user and the administrator. In the case of attended activity the message for the user will be display immediately.

java.lang.Exception - If anything else goes wrong. Activities can throw any subclass of Exception. All exceptions are caught and handled higher in the framework. If an activity fails, it is necessary to throw an exception from this method so that the process engine will be alerted that the activity failed.

run

@Deprecated
public final java.lang.Long run()
                                     throws java.lang.Exception

Deprecated. 08-07-2006 Use perform() instead.

This method is called by the framework when the activity is to be executed. This method calls execute() and then notifies the process engine of success, assuming the activity was successful. This method is not meant to be overridden and is thus final.

Returns:

The id of the next activity to execute.

Throws:

java.lang.Exception - If anything goes wrong.

run

@Deprecated
public final java.lang.Long run(ServiceContext sc_)
                                     throws java.lang.Exception

Deprecated. 08-07-2006 Use perform(ServiceContext) instead.

This method is called by the framework when the activity is to be executed. This method calls execute() and then notifies the process engine of success, assuming the activity was successful. This method is not meant to be overridden and is thus final.

Parameters:

sc_ - ServiceContext of the user executing the activity.

Returns:

The id of the next activity to execute.

Throws:

java.lang.Exception - If anything goes wrong.

execute

public SafeActivityReturnVariable[] execute(ActivityClassParameter[] inputs_,
                                            SafeActivityReturnVariable[] outputs_,
                                            java.lang.Object extraParameters_,
                                            ServiceContext sc_)
                                     throws ActivityExecutionException,
                                            java.lang.Exception

The actual method that implements an activity. This method is meant to be overridden in all subclasses.

Parameters:

inputs_ - The input parameters to the activity.

outputs_ - The structure for the outputs from the activity. This object graph should be populated and returned from this method.

extraParameters_ - Any extra parameters for the activity returned to the framework from the ActivityParameterHelper.createExtraOutputMap(com.appiancorp.suiteapi.process.ActivityClassParameter[])

sc_ - The activity will be performed under this service context

Returns:

The results of the activity execution.

Throws:

ActivityExecutionException - This exception contains the actual exception that occurred while executing the activity. It can also contain messages for both user and the administrator. In the case of attended activity the message for the user will be display immediately.

java.lang.Exception - If anything else goes wrong. Activities can throw any subclass of Exception. All exceptions are caught and handled higher in the framework. If an activity fails, it is necessary to throw an exception from this method so that the process engine will be alerted that the activity failed.

execute

@Deprecated
public SafeActivityReturnVariable[] execute(ActivityClassParameter[] inputs_,
                                                        SafeActivityReturnVariable[] outputs_,
                                                        java.lang.Object extraParameters_,
                                                        com.appiancorp.asl3.servicefw.connect.ServiceContext sc_)
                                                 throws ActivityExecutionException,
                                                        java.lang.Exception

Deprecated. since 6.0.3; override the other execute(ActivityClassParameter[], SafeActivityReturnVariable[], Object, ServiceContext)

Parameters:

inputs_ -

outputs_ -

extraParameters_ -

sc_ -

Returns:

Throws:

ActivityExecutionException

java.lang.Exception

getProcessModelProperties

public ProcessModelProperties getProcessModelProperties()

Specified by:

getProcessModelProperties in interface SmartServiceContext

Returns:

the properties of the ProcessModel

setProcessModelProperties

public void setProcessModelProperties(ProcessModelProperties processModelProperties_)

See Also:

getProcessModelProperties()

getProcessProperties

public ProcessProperties getProcessProperties()

Specified by:

getProcessProperties in interface SmartServiceContext

Returns:

the properties of the process

setProcessProperties

public void setProcessProperties(ProcessProperties processProperties_)

See Also:

getProcessProperties()

getTaskProperties

public TaskProperties getTaskProperties()

Specified by:

getTaskProperties in interface SmartServiceContext

Returns:

the properties of the task

setTaskProperties

public void setTaskProperties(TaskProperties taskProperties_)

See Also:

getTaskProperties()

setActivityProperties

public void setActivityProperties(ActivityProperties ap_)

Convenience method to set all properties at once.

Parameters:

ap_ - the properties of the task, process, and model for this activity

getMetadata

public ActivityExecutionMetadata getMetadata()

Description copied from interface: SmartServiceContext

Returns the metadata associated with this execution, including properties related to the Process Model and Tasks.

Specified by:

getMetadata in interface SmartServiceContext

Returns:

the metadata needed for the execution of the activity

setMetadata

public void setMetadata(ActivityExecutionMetadata metadata_)

See Also:

getMetadata()

setExtraParameters

public void setExtraParameters(java.lang.Object extraParameters_)

See Also:

getExtraParameters()

getExtraParameters

public java.lang.Object getExtraParameters()

Returns:

the extra parameters for the activity

getUser

public User getUser()

Returns:

the user executing the activity

getUsername

public java.lang.String getUsername()

Description copied from interface: SmartServiceContext

Returns the User for whom this Smart Service is executing.

Specified by:

getUsername in interface SmartServiceContext

See Also:

SmartServiceContext.getUserLocale()

setUser

public void setUser(User user_)

See Also:

getUser()

getActivityMap

public java.util.HashMap getActivityMap()

Retrieves the HashMap which stores key/value pairs to be used in a non-process environment after the activity executes. When the activity executes all key/value pairs in the HashMap will be copied to the request.

Note: It is recommended that users use a unique prefix for their keys to avoid potential conflicts.

Returns:

the activity's HashMap

setActivityMap

public void setActivityMap(java.util.HashMap activityMap_)

Sets the HashMap for this activity.

Parameters:

activityMap_ -

See Also:

getActivityMap()

getPrimaryLocale

public java.util.Locale getPrimaryLocale()

Description copied from interface: SmartServiceContext

Returns the primary Locale of the Appian System.

Specified by:

getPrimaryLocale in interface SmartServiceContext

Returns:

Returns the site's primaryLocale.

See Also:

SmartServiceContext.getUserLocale()

setPrimaryLocale

public void setPrimaryLocale(java.util.Locale primaryLocale_)

Parameters:

primaryLocale_ - The primaryLocale to set.

getUserLocale

public java.util.Locale getUserLocale()

Description copied from interface: SmartServiceContext

Returns the Locale of the User executing this Smart Service.

Specified by:

getUserLocale in interface SmartServiceContext

Returns:

Returns the userLocale.

See Also:

SmartServiceContext.getUsername(), SmartServiceContext.getPrimaryLocale()

setUserLocale

public void setUserLocale(java.util.Locale userLocale_)

Parameters:

userLocale_ - The userLocale to set.

lookupInWebAppJndi

@Deprecated
protected java.lang.Object lookupInWebAppJndi(java.lang.String name)
                                                   throws javax.naming.NamingException

Deprecated. The JNDI context "comp" should not be used. Use any context that does not begin with "comp", and retrieve the object using the standard JNDI syntax: Context ctx = new InitialContext(); Object o = ctx.lookup(name);

Returns the object stored in the Appian web app JNDI, under the given name. This is only needed for objects stored in the special "comp" context (such as "comp/env/jdbc").

Parameters:

name - The JNDI name to lookup.

Throws:

javax.naming.NamingException