IBM WebSphere Application ServerTM
Release 6

Package  com.ibm.bpe.api

Interface Summary
ActivityInstanceActionIndexThis interface defines symbolic constants to be used as a column index for the array of available action flags - see .
ActivityInstanceActionsThis interface defines symbolic constants for all actions that can be performed on activity instances.
ActivityServiceTemplateActionsThis interface defines symbolic constants for all actions that can be performed on activity service templates.
AutoDeletionModeThis interface defines symbolic constants that state whether a process instance is automatically deleted once it reaches an end execution state or not.
BusinessFlowManagerThe remote interface of the BusinessFlowManager bean.
BusinessFlowManagerHomeThe remote home interface of the BusinessFlowManager session bean.
BusinessFlowManagerServiceBusinessFlowManagerService defines the business functions that can be called by a local or remote client.
CompensationBehaviourThis interface defines symbolic constants that state how to deal with compensation.
CompleteAndClaimSuccessorResultReturns the result of a completeAndClaimSuccessor() call, that is, a description of the claimed successor activity instance.
CustomPropertyProvides a named custom property.
CustomPropertyInfoProvides information about a custom property.
EventHandlerTemplateActionsThis interface defines symbolic constants for all actions that can be performed on event handler templates.
ExpirationBehaviorThis interface defines symbolic constants that state how to deal with expirations.
InitiateAndClaimFirstResultReturns the result of an initiateAndClaimFirst() call.
LocalBusinessFlowManagerThe local interface of the BusinessFlowManager bean.
LocalBusinessFlowManagerHomeThe local home interface of the BusinessFlowManager session bean.
LocalBusinessFlowManagerServiceLocalBusinessFlowManagerService defines the business functions that can be called by a local client.
ObjectTypeThis interface defines symbolic constants for object types.
ProcessInstanceActionIndexThis interface defines symbolic constants to be used as a column index for the array of available action flags - see .
ProcessInstanceActionsThis interface defines symbolic constants for all actions that can be performed on process instances.
ProcessTemplateActionsThis interface defines symbolic constants for all actions that can be performed on process templates.
QueryPropertyReturns the properties of a variable that can be queried.
QueryPropertyExtensionReturns the properties of a variable that can be queried and information about the associated process template.
WorkItemActionsThis interface defines symbolic constants for all actions that can be performed on work items.
WorkListActionsThis interface defines symbolic constants for all actions that can be performed on work lists.
AIIDInterface for an activity instance object identifier.
ATIDInterface for an activity template object identifier.
AttributeInfoProvides information about an attribute of a query table.
AttributeMetaDataReturns the meta data of a query table attribute.
AuthorizationInfoProvides authorizations specifications of a query table.
ClientSettingInterface that supports the definition of user specific client settings.
CustomClientSettingsCustomClientSettings defines the interface for all client and Web client settings that are associated with a process template, process instance, or activity instance.
EHTIDInterface for an event handler template object identifier.
EntityDescribes an entity that is returned as the result of an entity-based query request against a query table.
EntityInfoProvides information about an entity that is returned as a result of a query against a query table.
EntityResultSetProvides the results of an entity-based query against a query table.
JspLocationInterface to retrieve JSP locations of a Web client setting.
KeyAttributesProvides information about key attributes.
OIDInterface for an object identifier.
PIIDInterface for a process instance object identifier.
PTIDInterface for a process template object identifier.
PortalClientSettingInterface for Portal client settings.
QueryResultSetProvides the results of a query request.
QueryTableMetaDataProvides the meta data of a query table.
ReplyContextThis interface supports an asynchronous mode of operation.
RowResultSetProvides the results of a row-based query against a query table.
StaffResultSetReturns the persons or groups that are members of a specific role.
StateObserverEventThis interface returns observer event specific information as there are the event number and the creation time.
VTIDInterface for a service template object identifier.
WebClientSettingInterface for Web client settings.
ActivityInstanceDataAccesses the properties of an activity instance.
ActivityServiceTemplateDataAccesses the properties of an activity service.
BranchTemplateDataAccesses the properties of a branch that follows a switch activity.
EventHandlerTemplateDataAccesses the properties of an event (action) that can be triggered as part of an active event handler.
LinkTemplateDataAccesses the properties of a link template.
ProcessInstanceDataAccesses the properties of a process instance.
ProcessTemplateDataAccesses the properties of a process template.
StoredQueryDataAccesses the properties of a query stored persistently.
WorkItemDataAccesses the properties of a work item.
WorkListDataAccesses the properties of a worklist.

Class Summary
BinaryCustomPropertyDescribes a custom property that has a binary value.
ClientObjectWrapperWraps messages and variables passed between the caller and the process engine.
ProcessResponseWrapperWraps the output message returned by a microflow and its associated custom client settings.
ReplyContextWrapperWraps the reply context passed to the process engine.
AdminAuthorizationOptionsDescribes administrative authorizations options for a query that uses a predefined or composite query table.
AttributeTypeThis enumeration class defines symbolic constants for attribute types.
AuthorizationOptionsStates authorizations options for a query that uses a predefined or composite query table.
AuthorizationTypeThis enumeration class defines symbolic constants for types of authorization.
ErrorTypeEnumThis enumeration class defines symbolic constants for error types that are found during validation of objects created spontaneously (ad-hoc).
FilterOptionsDescribes filtering options for a query against a query table.
JspApplicableRoleEnumThis enumeration class defines symbolic constants for JSP applicable role patterns.
JspUsageEnumThis enumeration class defines symbolic constants for JSP usage patterns.
MetaDataOptionsDescribes filtering options for retrieving the meta data of query tables.
ParameterDescribes a parameter and its value to set the value of a parameter that is used in query table filters and selection criteria.
QueryColumnInfoProvides information on the columns of a query result set.
QueryTableKindThis enumeration class defines symbolic constants for query table kinds.
StoredQueryPropertyDescribes a property of a stored query.

Exception Summary
ApplicationFaultExceptionAn ApplicationFaultException wraps fault responses from invoke, throw, or script activities.
ApplicationFaultException2An ApplicationFaultException2 extends ApplicationFaultException and additionally provides the namespace of the WSDL message that is associated with the thrown fault variable in case the fault variable is represented by a boxed Java simple type.
FaultReplyExceptionA FaultReplyException states that a modelled fault is returned.
FaultReplyException2A FaultReplyException2 states that a modelled fault is returned.
SpecificFaultReplyExceptionA SpecificFaultReplyException states that a fault is returned.
ActivityNameNotUniqueExceptionException class for error message Api.ActivityNameNotUnique.
ApplicationVetoExceptionException class for error message Api.ApplicationVeto.
BpelExceptionSuper class for all navigation related exceptions that can occur during the execution of BPEL processes.
CannotAccessObjectExceptionException class for error message Api.CannotAccessObject.
CannotDeleteNamespaceExceptionException class for error message Api.CannotDeleteNamespace.
CannotSendExceptionExceptionException class for error message Api.CannotSendException.
CannotSendPIIDExceptionException class for error message Api.CannotSendPIID.
CannotSendProcessResultExceptionException class for error message Api.CannotSendProcessResult.
CannotSendVoidReplyExceptionException class for error message Api.CannotSendVoidReply.
CouldNotCreateWSIFPort_ProcessExceptionException class for error message Api.CouldNotCreateWSIFPort_Process.
CreateFailedExceptionException class for error message Api.CreateFailed.
CreateRejectedExceptionException class for error message Api.CreateRejected.
DataHandlingExceptionException class for error message Api.DataHandling.
DatabaseExceptionException class for error message Api.Database.
EngineActivityCorrelationHandlingFailureExceptionException class for error message Engine.ActivityCorrelationHandlingFailure.
EngineActivityDoesNotExistExceptionException class for error message Engine.ActivityDoesNotExist.
EngineActivityMultipleJumpRequestsExceptionException class for error message Engine.ActivityMultipleJumpRequests.
EngineActivityNotAuthorizedExceptionException class for error message Engine.ActivityNotAuthorized.
EngineActivityStoppedExceptionException class for error message Engine.ActivityStopped.
EngineActivityWrongKindExceptionException class for error message Engine.ActivityWrongKind.
EngineActivityWrongKindForSignatureExceptionException class for error message Engine.ActivityWrongKindForSignature.
EngineActivityWrongStateExceptionException class for error message Engine.ActivityWrongState.
EngineActivityWrongStopReasonExceptionException class for error message Engine.ActivityWrongStopReason.
EngineAdministratorCannotBeResolvedExceptionException class for error message Engine.AdministratorCannotBeResolved.
EngineAmbiguousActivityExceptionException class for error message Engine.AmbiguousActivity.
EngineAmbiguousPropertyDefinitionExceptionException class for error message Engine.AmbiguousPropertyDefinition.
EngineAssignmentFailureExceptionExceptionException class for error message Engine.AssignmentFailureException.
EngineAuthorizationPluginExceptionException class for error message Engine.AuthorizationPlugin.
EngineBaseClassNotFoundExceptionException class for error message Engine.BaseClassNotFound.
EngineCalendarNotFoundExceptionException class for error message Engine.CalendarNotFound.
EngineCannotCreateWorkItemExceptionException class for error message Engine.CannotCreateWorkItem.
EngineCannotDeleteProcessExceptionException class for error message Engine.CannotDeleteProcess.
EngineCannotDeserializeReplyContextExceptionException class for error message Engine.CannotDeserializeReplyContext.
EngineCannotInitializePluginExceptionException class for error message Engine.CannotInitializePlugin.
EngineCannotInitializeVariableExceptionException class for error message Engine.CannotInitializeVariable.
EngineCannotInitializeWorkItemManagerExceptionException class for error message Engine.CannotInitializeWorkItemManager.
EngineCannotOpenCompensationSphereExceptionException class for error message Engine.CannotOpenCompensationSphere.
EngineCannotResolveEndpointExceptionException class for error message Engine.CannotResolveEndpoint.
EngineCannotResolveReplacementStringExceptionException class for error message Engine.CannotResolveReplacementString.
EngineCannotRunInAtomicSphereExceptionException class for error message Engine.CannotRunInAtomicSphere.
EngineCannotRunInterruptibleExceptionException class for error message Engine.CannotRunInterruptible.
EngineCannotRunSynchronousExceptionException class for error message Engine.CannotRunSynchronous.
EngineCannotUnwrapReplyContextExceptionException class for error message Engine.CannotUnwrapReplyContext.
EngineCompensationNotSupportedExceptionException class for error message Engine.CompensationNotSupported.
EngineCompensationSphereNotCompletedErrorException class for error message Engine.CompensationSphereNotCompleted.
EngineCompensationSphereRequiredExceptionException class for error message Engine.CompensationSphereRequired.
EngineCompensationSphereStateUnknownErrorException class for error message Engine.CompensationSphereStateUnknown.
EngineConditionEvaluationExceptionException class for error message Engine.ConditionEvaluation.
EngineConditionEvaluationFailedExceptionException class for error message Engine.ConditionEvaluationFailed.
EngineConflictingProcessExceptionException class for error message Engine.ConflictingProcess.
EngineContainerAppNotReachableErrorException class for error message Engine.ContainerAppNotReachable.
EngineCopyDataObjectErrorException class for error message Engine.CopyDataObject.
EngineCreateDataObjectErrorException class for error message Engine.CreateDataObject.
EngineCreateServiceReferenceExceptionException class for error message Engine.CreateServiceReference.
EngineCustomAttributeAccessViolationExceptionException class for error message Engine.CustomAttributeAccessViolation.
EngineDataMappingExceptionException class for error message Engine.DataMapping.
EngineDataPluginExceptionException class for error message Engine.DataPlugin.
EngineDuplicateAwaitedEventExceptionException class for error message Engine.DuplicateAwaitedEvent.
EngineDurationFormatExceptionException class for error message Engine.DurationFormat.
EngineEnforceRollbackErrorException class for error message Engine.EnforceRollback.
EngineErrorInActivityCustomPropertyResolutionExceptionException class for error message Engine.ErrorInActivityCustomPropertyResolution.
EngineErrorInDescriptionResolutionExceptionException class for error message Engine.ErrorInDescriptionResolution.
EngineEventHandlerCorrelationHandlingFailureExceptionException class for error message Engine.EventHandlerCorrelationHandlingFailure.
EngineEventNotKnownExceptionException class for error message Engine.EventNotKnown.
EngineEverybodyWorkItemExceptionException class for error message Engine.EverybodyWorkItem.
EngineExitConditionEvaluationExceptionException class for error message Engine.ExitConditionEvaluation.
EngineExitConditionExpressionEvaluationFailedExceptionException class for error message Engine.ExitConditionExpressionEvaluationFailed.
EngineExitConditionFailedExceptionException class for error message Engine.ExitConditionFailed.
EngineFaultTerminalMessageIsNullExceptionException class for error message Engine.FaultTerminalMessageIsNull.
EngineFaultTerminalNotConnectedExceptionException class for error message Engine.FaultTerminalNotConnected.
EngineForEachExpressionEvaluationExceptionException class for error message Engine.ForEachExpressionEvaluation.
EngineGenericErrorExceptionException class for error message Engine.GenericError.
EngineGetTypeErrorException class for error message Engine.GetType.
EngineImplQualTranMustBeGlobalExceptionException class for error message Engine.ImplQualTranMustBeGlobal.
EngineImplementationDoesNotExistExceptionException class for error message Engine.ImplementationDoesNotExist.
EngineImplementationInvocationExceptionException class for error message Engine.ImplementationInvocation.
EngineIncompatibleTypesExceptionException class for error message Engine.IncompatibleTypes.
EngineIncompleteUserInputExceptionException class for error message Engine.IncompleteUserInput.
EngineInitializingScopeNotReachedExceptionException class for error message Engine.InitializingScopeNotReached.
EngineInstanceLocationFailureExceptionException class for error message Engine.InstanceLocationFailure.
EngineInvalidCompensationSphereDescriptorExceptionException class for error message Engine.InvalidCompensationSphereDescriptor.
EngineInvalidDurationExceptionException class for error message Engine.InvalidDuration.
EngineInvalidDurationInEventHandlerExceptionException class for error message Engine.InvalidDurationInEventHandler.
EngineInvalidFaultTerminalExceptionException class for error message Engine.InvalidFaultTerminal.
EngineInvalidLinkTypeExceptionException class for error message Engine.InvalidLinkType.
EngineInvalidNamespaceURIExceptionException class for error message Engine.InvalidNamespaceURI.
EngineInvalidNumberOfLinksExceptionException class for error message Engine.InvalidNumberOfLinks.
EngineInvalidReplacementVariableExceptionException class for error message Engine.InvalidReplacementVariable.
EngineJavaExecutionFailedExceptionException class for error message Engine.JavaExecutionFailed.
EngineJmsApiContextExceptionException class for error message Engine.JmsApiContext.
EngineJoinConditionEvaluationExceptionException class for error message Engine.JoinConditionEvaluation.
EngineJoinConditionFailedExceptionException class for error message Engine.JoinConditionFailed.
EngineLastAdminWorkItemExceptionException class for error message Engine.LastAdminWorkItem.
EngineLinkConditionEvaluationExceptionException class for error message Engine.LinkConditionEvaluation.
EngineLinkDoesNotExistExceptionException class for error message Engine.LinkDoesNotExist.
EngineLookupProcessBeanErrorException class for error message Engine.LookupProcessBean.
EngineLoopConditionEvaluationExceptionException class for error message Engine.LoopConditionEvaluation.
EngineLoopDefaultMappingExceptionException class for error message Engine.LoopDefaultMapping.
EngineLoopMappingExceptionException class for error message Engine.LoopMapping.
EngineMaxNumberLoopIterationsExceededExceptionException class for error message Engine.MaxNumberLoopIterationsExceeded.
EngineMaxNumberRetryExceededExceptionException class for error message Engine.MaxNumberRetryExceeded.
EngineMessageAndCorrelationSetMismatchExceptionException class for error message Engine.MessageAndCorrelationSetMismatch.
EngineMissingReceiveExceptionAn EngineMisssingReceiveException is thrown when a message has been received and stored by Process Choreographer and when that message has not been processed before the completion of the process instance for which it was received.
EngineMissingReplyExceptionAn EngineMisssingReplyException is thrown when the process instance ends and when there is a reply missing for a receive or pick activity that implements a two-way operation.
EngineNoInitialReceiveExceptionException class for error message Engine.NoInitialReceive.
EngineNoServiceRefTypeExceptionException class for error message Engine.NoServiceRefType.
EngineNotAuthorizedExceptionException class for error message Engine.NotAuthorized.
EngineNullMessageExceptionException class for error message Engine.NullMessage.
EngineParameterNullExceptionException class for error message Engine.ParameterNull.
EngineParentProcessContextExceptionException class for error message Engine.ParentProcessContext.
EngineProcessDoesNotExistExceptionException class for error message Engine.ProcessDoesNotExist.
EngineProcessInstanceNameNotUniqueExceptionException class for error message Engine.ProcessInstanceNameNotUnique.
EngineProcessModelDoesNotExistExceptionException class for error message Engine.ProcessModelDoesNotExist.
EngineProcessModelStoppedExceptionException class for error message Engine.ProcessModelStopped.
EngineProcessNotAuthorizedExceptionException class for error message Engine.ProcessNotAuthorized.
EngineProcessReaderWorkItemExceptionException class for error message Engine.ProcessReaderWorkItem.
EngineProcessStarterDeletedExceptionException class for error message Engine.ProcessStarterDeleted.
EngineProcessWrongBuildVersionExceptionException class for error message Engine.ProcessWrongBuildVersion.
EngineProcessWrongKindExceptionException class for error message Engine.ProcessWrongKind.
EngineProcessWrongStateExceptionException class for error message Engine.ProcessWrongState.
EngineRefQualDeliverAsyncAtMustBeCommitExceptionException class for error message Engine.RefQualDeliverAsyncAtMustBeCommit.
EngineRepeatedCompensationExceptionExceptionException class for error message Engine.RepeatedCompensationException.
EngineRequestRejectedExceptionException class for error message Engine.RequestRejected.
EngineRollbackOnlyErrorException class for error message Engine.RollbackOnly.
EngineSchedulerExceptionException class for error message Engine.Scheduler.
EngineSchedulerNotFoundExceptionException class for error message Engine.SchedulerNotFound.
EngineSelectionFailureExceptionExceptionException class for error message Engine.SelectionFailureException.
EngineServiceNotAuthorizedExceptionException class for error message Engine.ServiceNotAuthorized.
EngineStateObserverEventErrorException class for error message Engine.StateObserverEvent.
EngineSubProcessHasNoMatchingEventExceptionException class for error message Engine.SubProcessHasNoMatchingEvent.
EngineTimeoutExpressionEvaluationExceptionException class for error message Engine.TimeoutExpressionEvaluation.
EngineTimeoutExpressionEvaluationFailedExceptionException class for error message Engine.TimeoutExpressionEvaluationFailed.
EngineTimeoutExpressionEvaluationInEventHandlerExceptionException class for error message Engine.TimeoutExpressionEvaluationInEventHandler.
EngineTransitionConditionEvaluationExceptionException class for error message Engine.TransitionConditionEvaluation.
EngineTransitionConditionFailedExceptionException class for error message Engine.TransitionConditionFailed.
EngineUncaughtExceptionInActivityExceptionException class for error message Engine.UncaughtExceptionInActivity.
EngineUncheckedBusinessFaultExceptionException class for error message Engine.UncheckedBusinessFault.
EngineUnknownActivityExceptionException class for error message Engine.UnknownActivity.
EngineUnknownInboundOperationExceptionException class for error message Engine.UnknownInboundOperation.
EngineUnknownNamespaceURIExceptionException class for error message Engine.UnknownNamespaceURI.
EngineUnknownOperationExceptionException class for error message Engine.UnknownOperation.
EngineUnsupportedJumpExceptionException class for error message Engine.UnsupportedJump.
EngineVariableDoesNotExistExceptionException class for error message Engine.VariableDoesNotExist.
EngineVariableNotVisibleExceptionException class for error message Engine.VariableNotVisible.
EngineWorkCompletionContractRollbackErrorException class for error message Engine.WorkCompletionContractRollback.
EngineWrongActivityNameExceptionException class for error message Engine.WrongActivityName.
EngineWrongKindExceptionException class for error message Engine.WrongKind.
EngineWrongMessageTypeExceptionException class for error message Engine.WrongMessageType.
EngineWrongStateExceptionException class for error message Engine.WrongState.
EngineWrongTaskKindExceptionAn EngineWrongTaskKindException encapsulates a TaskWrongKindException thrown by the Human Task Manager and signals such a failure to a Business Flow Manager user.
EngineWrongTaskStateExceptionAn EngineWrongTaskStateException encapsulates a TaskWrongStateException thrown by the Human Task Manager and signals such a failure to a Business Flow Manager user.
EngineWrongTaskTemplateExceptionException class for error message Engine.WrongTaskTemplate.
ExecuteInputOnlyOperation_NotSupportedExceptionException class for error message Api.ExecuteInputOnlyOperation_NotSupported.
GenericErrorExceptionException class for error message Api.GenericError.
GroupWorkItemExceptionException class for error message Api.GroupWorkItem.
HumanTaskManagerExceptionException class for error message Api.HumanTaskManager.
IdAndCorrelationSetMismatchExceptionException class for error message Api.IdAndCorrelationSetMismatch.
IdWrongFormatExceptionException class for error message Api.IdWrongFormat.
IdWrongTypeExceptionException class for error message Api.IdWrongType.
ImplementationNotFoundExceptionException class for error message Api.ImplementationNotFound.
InvalidLengthExceptionException class for error message Api.InvalidLength.
InvalidMessagePartTypeExceptionException class for error message Api.InvalidMessagePartType.
InvalidMessageTypeExceptionException class for error message Api.InvalidMessageType.
InvalidObjectNameExceptionException class for error message Api.InvalidObjectName.
InvalidParameterExceptionException class for error message Api.InvalidParameter.
InvalidParameterValueExceptionException class for error message Api.InvalidParameterValue.
InvalidPropertyAliasTypeExceptionException class for error message Api.InvalidPropertyAliasType.
InvalidStoredQueryParametersExceptionException class for error message Api.InvalidStoredQueryParameters.
MessagePartNotFoundExceptionException class for error message Api.MessagePartNotFound.
MessagePartQueryFailedExceptionException class for error message Api.MessagePartQueryFailed.
MethodNotApplicableExceptionException class for error message Api.MethodNotApplicable.
MissingPartsExceptionException class for error message Api.MissingParts.
MultipleInstanceExceptionException class for error message Api.MultipleInstance.
NoMacroFlowExceptionException class for error message Api.NoMacroFlow.
NotSerializableExceptionNotSerializableException is basically a placeholder for nested exceptions that serialization fails.
ObjectDoesNotExistExceptionException class for error message Api.ObjectDoesNotExist.
ProcessBindingMissingFormatTypeExceptionException class for error message Api.ProcessBindingMissingFormatType.
ProcessBindingMissingTypeMappingExceptionException class for error message Api.ProcessBindingMissingTypeMapping.
ProcessErrorThis is the base class for all Business Flow Manager runtime exceptions.
ProcessExceptionThis is the base class for all exceptions thrown by the Business Flow Manager EJB API.
ProcessInputTypeNameNullExceptionException class for error message Api.ProcessInputTypeNameNull.
ProcessInputTypeSystemNullExceptionException class for error message Api.ProcessInputTypeSystemNull.
ProcessInputUnknownTypeSystemExceptionException class for error message Api.ProcessInputUnknownTypeSystem.
ProcessInstanceNotUniqueExceptionException class for error message Api.ProcessInstanceNotUnique.
ProcessOperationCannotFindModelExceptionException class for error message Api.ProcessOperationCannotFindModel.
ProcessOperationCannotInvokeExceptionException class for error message Api.ProcessOperationCannotInvoke.
ProcessOperationFailedExceptionException class for error message Api.ProcessOperationFailed.
ProcessOperationFaultNameNotSetExceptionException class for error message Api.ProcessOperationFaultNameNotSet.
ProcessOperationMissingFaultMessageExceptionException class for error message Api.ProcessOperationMissingFaultMessage.
ProcessOperationNoOutputMessageExceptionException class for error message Api.ProcessOperationNoOutputMessage.
ProcessOperationNotKnownByPortExceptionException class for error message Api.ProcessOperationNotKnownByPort.
ProcessOperationUnknownFaultMessageTypeExceptionException class for error message Api.ProcessOperationUnknownFaultMessageType.
ProcessTemplateNotFoundExceptionException class for error message Api.ProcessTemplateNotFound.
QueryCannotJoinExceptionException class for error message Api.QueryCannotJoin.
QueryExceptionException class for error message Api.Query.
QueryHintExceptionException class for error message Api.QueryHint.
QueryHintInvalidExceptionException class for error message Api.QueryHintInvalid.
QueryHintScopeInvalidExceptionException class for error message Api.QueryHintScopeInvalid.
QueryHintValueInvalidExceptionException class for error message Api.QueryHintValueInvalid.
QueryInvalidOperandExceptionException class for error message Api.QueryInvalidOperand.
QueryInvalidParameterExceptionException class for error message Api.QueryInvalidParameter.
QueryInvalidTimestampExceptionException class for error message Api.QueryInvalidTimestamp.
QueryUndefinedParameterExceptionException class for error message Api.QueryUndefinedParameter.
QueryUnknownColumnExceptionException class for error message Api.QueryUnknownColumn.
QueryUnknownOperatorExceptionException class for error message Api.QueryUnknownOperator.
QueryUnknownTableExceptionException class for error message Api.QueryUnknownTable.
RuntimeFaultExceptionRuntimeFaultException wraps all runtime failures that can happen during the execution of BPEL processes, for example, when executing a script activity or when evaluating a transition condition.
SendReplyErrorExceptionRepresents the exception that is thrown by ReplyContext methods if sending the reply generates an error.
ServiceNotUniqueExceptionException class for error message Api.ServiceNotUnique.
StandardFaultExceptionSuper class for all BPEL standard faults such as bpws:forceTermination.
StoredQueryNameNotUniqueExceptionException class for error message Api.StoredQueryNameNotUnique.
SystemFaultExceptionDefines an exception which is thrown when during the execution of an activity or the invocation of a plug-in (except the observer plug-in), Process Choreographer itself runs into an error situation.
TaskManagerNotFoundExceptionException class for error message Api.TaskManagerNotFound.
TemplateInUseExceptionException class for error message Api.TemplateInUse.
UnexpectedFailureExceptionException class for error message Api.UnexpectedFailure.
UnhandledFaultExceptionSuper class for all unhandled fault exceptions.
UserDoesNotExistExceptionException class for error message Api.UserDoesNotExist.
UserRegistryExceptionException class for error message Api.UserRegistry.
WorkItemDoesNotExistExceptionException class for error message Api.WorkItemDoesNotExist.
WorkItemManagerExceptionA general non-recoverable exception that occured with Work Item Management functions.



Package Description

Provides the application programming interface (API) for managing process-related objects in the ProcessChoreographer Business Flow Manager. You can create application programs that use the API to manage runtime information related to processes. You can:

The API contains a stateless session bean BusinessFlowManager for local and remote access. The BusinessFlowManagerService interface describes the functions that can be called locally and remotely. It exposes the functions that can be called by an application program. The application program can be any Java program, including another EJB.

The application program accesses the BusinessFlowManager session bean through the bean's home and remote or local interfaces. A reference must be added to your application deployment descriptor. For example, for client applications such as a J2EE client application add the reference to the application-client.xml, for a Web application to the web.xml, and for an EJB application to the ejb-jar.xml.

Add the reference to the remote interface as in the following example:

   <ejb-ref>
     <ejb-ref-name>ejb/BusinessFlowManagerHome</ejb-ref-name>
     <ejb-ref-type>Session<ejb-ref-type>
     <home>com.ibm.bpe.api.BusinessFlowManagerHome</home>
     <remote>com.ibm.bpe.api.BusinessFlowManager</remote>
   </ejb-ref>

Add the reference to the local interface as in the following example:

   <ejb-local-ref>
     <ejb-ref-name>ejb/LocalBusinessFlowManagerHome</ejb-ref-name>
     <ejb-ref-type>Session<ejb-ref-type>
     <local-home>com.ibm.bpe.api.LocalBusinessFlowManagerHome</local-home>
     <local>com.ibm.bpe.api.LocalBusinessFlowManager</local>
   </ejb-local-ref>

If you use WebSphere Integration Developer to add the EJB reference to the deployment descriptor, the binding for the EJB reference is automatically created when the application is deployed.

If you use the remote interface of the BusinessFlowManager bean, complete the following actions:

The BusinessFlowManager home interface is then made available to the client through JNDI by the container where the BusinessFlowManager session bean is deployed. To access the remote interface:

   // Obtain the default initial JNDI context
   Context initialContext= new InitialContext();
   // Lookup the remote home interface of the BusinessFlowManager bean
   Object result= initialContext.lookup("java:comp/env/ejb/BusinessFlowManagerHome");
   // Convert the lookup result to the proper type
   BusinessFlowManagerHome processHome= (BusinessFlowManagerHome)javax.rmi.PortableRemoteObject.narrow(result,BusinessFlowManagerHome.class);
To access the local interface:
   // Obtain the default initial JNDI context
   Context initialContext= new InitialContext();
   // Lookup the local home interface of the BusinessFlowManager bean
   LocalBusinessFlowManagerHome processHome= (LocalBusinessFlowManagerHome)initialContext.lookup("java:comp/env/ejb/LocalBusinessFlowManagerHome");

The home interface contains a create method that returns the BusinessFlowManager session bean's remote or local interface. For example, access the remote interface of the session bean:

   BusinessFlowManager process= processHome.create();
For example, access the local interface of the session bean:
   LocalBusinessFlowManager process= processHome.create();

When the BusinessFlowManager session bean is accessed, the application program can call any of the business functions exposed by the API. For example:

   process.initiate("MyProcessModel",input);

If the method called does not complete successfully, an exception is thrown that denotes the cause of the error. You can handle this exception specifically to provide guidance to the caller.

However, it is common practice to handle only a subset of the exceptions specifically and to provide general guidance for the other potential exceptions. All specific exceptions inherit from a generic ProcessException. It is a best practice to catch the generic exception with a final catch(ProcessException) statement. This statement helps to ensure the upward compatibility of your application program because it takes account of all of the other exceptions that can occur, now and in future releases.

When a method is called, null can be specified as a parameter value to indicate that a value is not passed. For example, the order-by clause of a query call can be null to indicate that the result of the query is not to be sorted.

Always qualify your null values to prevent potential upgrade problems to a newer level of WebSphere Process Server, for example, specify (String)null or (Integer)null instead of just null.

Also note that access to the BusinessFlowManager session bean does not guarantee that all functions can be executed; the caller must also be authorized for these actions.

When an instance of the BusinessFlowManager session bean is created, the container associates a context with the instance of the session bean. The context contains the caller's principal ID, a group membership list, and indicates whether the caller has one of the Business Flow Manager J2EE roles, that is, whether the caller belongs to the group of BPE system administrators or monitors. The context is used by both the container and the process engine to check the caller's authorization for each call even when global security is not set. If global security is not set, the caller's principal ID has the value 'UNAUTHENTICATED'.

In other words, if global security is set, you need to login before the API can be accessed.

Calls from applications are run as transactions. A transaction is either established and ended explicitly by the application program, or established by the container when the application progam calls the process engine and ended by the container when the application program receives the result (the deployment descriptor specifies TX_REQUIRED). For example, the application program can establish and end a transaction as follows:

   // Obtain user transaction interface
   UserTransaction transaction= (UserTransaction)intialContext.lookup("jta/usertransaction");
   // Begin a transaction
   transaction.begin();
      // Process calls ...
   // On successful return, commit the transaction
   transaction.commit();
Design your own transactions to prevent database deadlocks when multiple transaction instances are run concurrently. For example, avoid running statements similar to the following in parallel:
   UserTransaction transaction= (UserTransaction)intialContext.lookup("jta/usertransaction");
   transaction.begin();
     process.getActivityInstance(aiid); // read-locks the activity
     process.claim(aiid);               // write-locks the activity to update the state
   transaction.commit();

The following table shows how WebSphere Process Server terms map to WebSphere Integration Developer terms.
WebSphere Process Server WebSphere Integration Developer
participating task to-do task
staff activity human task activity


IBM WebSphere Application ServerTM
Release 6