atg.process

Interface ProcessExecutionContext

All Superinterfaces:

ComponentNameResolver, NameResolver

public interface ProcessExecutionContext
extends ComponentNameResolver

Represents the context in which a process segment is being executed. The information in the context can be used to evaluate Expressions, and to execute Actions.

This interface extends ComponentNameResolver, and can thus be used to resolve arbitrary Nucleus names, either as Strings or as ComponentNames. If the process segment is being executed in the context of an HTTP request, the NameResolver can be used to resolve request-scoped components; otherwise, it can only resolve global components.

See Also:

Expression, Action

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	getMessage() Returns the JMS message bean which prompted the process segment execution to start or resume.
java.lang.String	getMessageType() Returns the JMS type of the message which prompted the process segment execution to start or resume.
RepositoryItem	getProcessInstance() Returns the process instance going through the process segment.
DynamoHttpServletRequest	getRequest() Returns the current HTTP request, null if the process segment is not being executed in the context of an HTTP request.
DynamoHttpServletResponse	getResponse() Returns the current HTTP response, null if the process segment is not being executed in the context of an HTTP request.
Site	getSite() Returns the site the triggering event uses, if any
RepositoryItem	getSubject() Returns the subject going through the process segment, null if the segment is not being executed in the context of an individual subject.
boolean	isIndividual() Returns true if this context corresponds to an individual subject going through the process segment, false if it corresponds to a "collective" process instance which operates on behalf of all subjects.

Methods inherited from interface atg.nucleus.naming.ComponentNameResolver

resolveName

Methods inherited from interface atg.naming.NameResolver

resolveName

Field Detail

CLASS_VERSION

static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

Method Detail

isIndividual

boolean isIndividual()

Returns true if this context corresponds to an individual subject going through the process segment, false if it corresponds to a "collective" process instance which operates on behalf of all subjects.

getProcessInstance

RepositoryItem getProcessInstance()

Returns the process instance going through the process segment. If the segment is being executed in the context of an individual subject (that is, if isIndividual is true), the process instance points to that subject, and any context variables set during the segment execution; otherwise, this is a "collective" process instance which represents, and operates on behalf of, all subjects.

getSubject

RepositoryItem getSubject()

Returns the subject going through the process segment, null if the segment is not being executed in the context of an individual subject.

getMessageType

java.lang.String getMessageType()

Returns the JMS type of the message which prompted the process segment execution to start or resume.

getMessage

java.lang.Object getMessage()

Returns the JMS message bean which prompted the process segment execution to start or resume. The message could represent an individual event, a global event, or a timer.

getRequest

DynamoHttpServletRequest getRequest()

Returns the current HTTP request, null if the process segment is not being executed in the context of an HTTP request.

getResponse

DynamoHttpServletResponse getResponse()

Returns the current HTTP response, null if the process segment is not being executed in the context of an HTTP request.

getSite

Site getSite()

Returns the site the triggering event uses, if any

Returns:

the site the triggering event uses, or null if the event does not contain site information