Skip navigation links

oracle.bpm.services.instancequery
Interface IInstanceQueryService

public interface IInstanceQueryService

Method Summary

IGrabInstanceContextResponse	createGrabInstanceContext(IBPMContext context, IGrabInstanceContextRequest grabInstanceContextRequest)
IGrabMultipleInstancesContextResponse	createGrabMultipleInstancesContext(IBPMContext context, IGrabMultipleInstancesContextRequest grabMultipleInstancesContextRequest)
IMigrateInstanceContextResponse	createMigrateInstanceContext(IBPMContext context, IMigrateInstanceContextRequest migrateInstanceContextRequest)
IMigrateMultipleInstancesContextResponse	createMigrateMultipleInstancesContext(IBPMContext context, IMigrateMultipleInstancesContextRequest migrateMultipleInstancesContextRequest)
IGrabInstanceContext	findGrabInstanceContextForActivity(IBPMContext context, IProcessInstance instance, IOpenActivityInfo openActivity, IInstanceContextConfiguration configuration)
java.util.List<IAuditInstance>	getActiveInstancesAsOfQueryId(IBPMContext context, long queryId) Deprecated.
java.util.Map<java.lang.String,java.lang.String>	getActivityTypes(IBPMContext context, java.lang.String compositeDN, java.lang.String componentName)
java.util.List<IAuditInstance>	getAllInstancesAfterQueryId(IBPMContext context, long queryId) Deprecated.
byte[]	getAuditInstancePayload(IBPMContext ctx, long queryId) Deprecated.
java.lang.String	getAuditInstancePayloadXML(IBPMContext ctx, long queryId) Given a query ID, this method will return the audit detail XML that are attached to a particular task.
java.lang.Iterable<java.lang.String>	getComponentsPendingMigration(IBPMContext context)
int	getCountOfInstancesPendingMigration(IBPMContext context, java.lang.String processDN)
int	getCountOfProcessInstances(IBPMContext context, java.lang.String processDN)
java.util.List<java.lang.String>	getInstancesActedByAssignee(IBPMContext context, java.util.Calendar startDate, java.util.Calendar endDate) Returns list of instances updated by user bases on star updated date and end updated date
java.util.List<IProcessInstanceUser>	getInstanceUpdatedUserHistoryByInstanceId(IBPMContext context, java.lang.String instanceId) This will return of user who acted on the instance via instance or tasks initiated from that instance
java.util.List<IProcessInstanceUser>	getInstanceUpdatedUserHistoryByTaskNumber(IBPMContext context, int taskNumber) This will return of user who acted on the instance based on task number via instance or tasks initiated from that instance
java.util.List<IProcessAttachment>	getProcessAttachments(IBPMContext context, IProcessInstance instance) Return process attachments
java.lang.String	getProcessAuditDiagram(IBPMContext bpmContext, java.lang.String instanceId, java.util.Locale locale) Given a process instance id creates the process audit image
java.util.List<IProcessComment>	getProcessComments(IBPMContext context, IProcessInstance instance) Returns comments based on instance
java.lang.String	getProcessDiagram(IBPMContext bpmContext, java.lang.String instanceId, java.util.Locale locale) Given a process instance id creates the process image
IProcessInstance	getProcessInstance(IBPMContext context, int processNumber)
IProcessInstance	getProcessInstance(IBPMContext context, java.lang.String processId)
java.lang.Iterable<IProcessInstance>	getProcessInstancesPendingMigration(IBPMContext context, java.lang.String processDN, int startRow, int endRow)
java.util.List<IAuditInstance>	queryAuditInstanceByProcessId(IBPMContext context, java.lang.String instanceId) Returns all audit instances for a given process ID.
java.util.List<IAuditInstance>	queryAuditInstances(IBPMContext context, int firstResult, int resultPageSize, boolean active, int totalResults, java.util.Calendar referenceTime, long backTrackTime) Returns a paged list of IAuditInstance records.
java.util.List<IAuditInstance>	queryAuditInstances(IBPMContext context, java.lang.String expression) Returns a List of IAuditInstance based on the JPQL Expression.
java.util.List<IAuditInstance>	queryAuditInstances(IBPMContext context, java.lang.String expression, java.util.Map<java.lang.String,java.lang.Object> parameters) Returns a List of IAuditInstance based on the JPQL Expression and a Map of parameters and values.
java.util.List<IAuditInstance>	queryAuditInstances(IBPMContext context, java.lang.String tablePrefix, java.lang.String expression, java.lang.String orderBy, java.util.Map<java.lang.String,java.lang.Object> parameters, int pageStart, int pageSize) Returns a List of IAuditInstance based on the JPQL expression.
java.util.List<IProcessInstance>	queryInstances(IBPMContext context, java.util.List<Column> displayColumns, Predicate predicate, Ordering ordering, IInstanceQueryInput queryInput)
java.util.List<IProcessInstance>	queryParallelInstances(IBPMContext context, IProcessInstance instance, java.util.List<Column> displayColumns)
java.util.List<IProcessInstance>	queryProcessInstances(IBPMContext context, java.util.List<Column> displayColumns, Predicate predicate, Ordering ordering, IInstanceQueryInput queryInput)
java.util.List<IProcessInstance>	queryViewInstances(IBPMContext context, java.lang.String viewId, Predicate extraPredicate, Ordering ordering, int startRow, int endRow) Query process instances using the specified view.
java.util.List<IProcessInstance>	queryViewProcessInstances(IBPMContext context, java.lang.String viewId, Predicate extraPredicate, Ordering ordering, int startRow, int endRow) Query process instances using the specified view.

Method Detail

getActivityTypes

java.util.Map<java.lang.String,java.lang.String> getActivityTypes(IBPMContext context,
                                                                  java.lang.String compositeDN,
                                                                  java.lang.String componentName)
                                                                  throws BPMException

Parameters:

context -

compositeDN -

componentName -

Returns:

Throws:

BPMException

queryViewInstances

java.util.List<IProcessInstance> queryViewInstances(IBPMContext context,
                                                    java.lang.String viewId,
                                                    Predicate extraPredicate,
                                                    Ordering ordering,
                                                    int startRow,
                                                    int endRow)
                                                    throws BPMException

Query process instances using the specified view. All process instances (including process instances for parallel threads) that match the view criteria will be returned. The instances returned by the view can be further filtered by specifying an optional additional Predicate, and any ordering specified in the view can be overridden by specifying an optional Ordering predicate. Only views of type PROCESS_VIEW or STANDARD_PROCESS_VIEW can be used with this API. Note that the context user must have access to the specified view. In addition, this API currently only supports granting of view definitions, not granting view data. If a user has access to a view by virtue of a DATA grant, it will be treated as a definition grant. (That is, the view will select processes as the view grantee, not the as the original owner of the view).

Parameters:

context -

viewId - id of the view to use to query process instances.

extraPredicate - optional additional Predicate to use to further filter instances selected by the view. If null, no additional predicate will be applied.

ordering - optional Ordering to use for the selected instances. If null, the Ordering specified by the view will be used.

startRow - the number of the first row to use in paging queries. If a value of zero or less is specified, the query will not be paged, and all rows from the query will be returned.

endRow - the number of the last row to use in paging queries. If a value of zero or less is specified, the query will not be paged, and all rows from the query will be returned.

Returns:

a list of IProcessInstances returned by the specified view.

Throws:

BPMException

queryViewProcessInstances

java.util.List<IProcessInstance> queryViewProcessInstances(IBPMContext context,
                                                           java.lang.String viewId,
                                                           Predicate extraPredicate,
                                                           Ordering ordering,
                                                           int startRow,
                                                           int endRow)
                                                           throws BPMException

Query process instances using the specified view. Only the main process instances will be returned. Process instances for parallel threads will not be returned. The instances returned by the view can be further filtered by specifying an optional additional Predicate, and any ordering specified in the view can be overridden by specifying an optional Ordering predicate. Only views of type PROCESS_VIEW or STANDARD_PROCESS_VIEW can be used with this API. Note that the context user must have access to the specified view. In addition, this API currently only supports granting of view definitions, not granting view data. If a user has access to a view by virtue of a DATA grant, it will be treated as a definition grant. (That is, the view will select processes as the view grantee, not the as the original owner of the view).

Parameters:

context -

viewId - id of the view to use to query process instances.

extraPredicate - optional additional Predicate to use to further filter instances selected by the view. If null, no additional predicate will be applied.

ordering - optional Ordering to use for the selected instances. If null, the Ordering specified by the view will be used.

startRow - the number of the first row to use in paging queries. If a value of zero or less is specified, the query will not be paged, and all rows from the query will be returned.

endRow - the number of the last row to use in paging queries. If a value of zero or less is specified, the query will not be paged, and all rows from the query will be returned.

Returns:

a list of IProcessInstances returned by the specified view.

Throws:

BPMException

getInstancesActedByAssignee

java.util.List<java.lang.String> getInstancesActedByAssignee(IBPMContext context,
                                                             java.util.Calendar startDate,
                                                             java.util.Calendar endDate)
                                                             throws BPMException

Returns list of instances updated by user bases on star updated date and end updated date

Parameters:

context -

startDate -

endDate -

Returns:

Throws:

BPMException

getInstanceUpdatedUserHistoryByInstanceId

java.util.List<IProcessInstanceUser> getInstanceUpdatedUserHistoryByInstanceId(IBPMContext context,
                                                                               java.lang.String instanceId)
                                                                               throws BPMException

This will return of user who acted on the instance via instance or tasks initiated from that instance

Parameters:

context -

instanceId -

Returns:

Throws:

BPMException

getInstanceUpdatedUserHistoryByTaskNumber

java.util.List<IProcessInstanceUser> getInstanceUpdatedUserHistoryByTaskNumber(IBPMContext context,
                                                                               int taskNumber)
                                                                               throws BPMException

This will return of user who acted on the instance based on task number via instance or tasks initiated from that instance

Parameters:

context -

taskNumber -

Returns:

Throws:

BPMException

getProcessComments

java.util.List<IProcessComment> getProcessComments(IBPMContext context,
                                                   IProcessInstance instance)
                                                   throws BPMException

Returns comments based on instance

Parameters:

context -

instance -

Returns:

Throws:

BPMException

getProcessAttachments

java.util.List<IProcessAttachment> getProcessAttachments(IBPMContext context,
                                                         IProcessInstance instance)
                                                         throws BPMException

Return process attachments

Parameters:

context -

instance -

Returns:

Throws:

BPMException

queryParallelInstances

java.util.List<IProcessInstance> queryParallelInstances(IBPMContext context,
                                                        IProcessInstance instance,
                                                        java.util.List<Column> displayColumns)
                                                        throws BPMException

Throws:

BPMException

queryInstances

java.util.List<IProcessInstance> queryInstances(IBPMContext context,
                                                java.util.List<Column> displayColumns,
                                                Predicate predicate,
                                                Ordering ordering,
                                                IInstanceQueryInput queryInput)
                                                throws BPMException

Parameters:

context -

displayColumns -

predicate -

ordering -

queryInput -

Returns:

Throws:

BPMException

queryProcessInstances

java.util.List<IProcessInstance> queryProcessInstances(IBPMContext context,
                                                       java.util.List<Column> displayColumns,
                                                       Predicate predicate,
                                                       Ordering ordering,
                                                       IInstanceQueryInput queryInput)
                                                       throws BPMException

Parameters:

context -

displayColumns -

predicate -

ordering -

queryInput -

Returns:

Throws:

BPMException

getProcessInstance

IProcessInstance getProcessInstance(IBPMContext context,
                                    int processNumber)
                                    throws BPMException

Parameters:

context -

processNumber -

Returns:

Throws:

BPMException

getProcessInstance

IProcessInstance getProcessInstance(IBPMContext context,
                                    java.lang.String processId)
                                    throws BPMException

Parameters:

context -

processId -

Returns:

Throws:

BPMException

queryAuditInstanceByProcessId

java.util.List<IAuditInstance> queryAuditInstanceByProcessId(IBPMContext context,
                                                             java.lang.String instanceId)
                                                             throws BPMException

Returns all audit instances for a given process ID. The process ID conforms to the Long compositeInstanceId.

Parameters:

instanceId -

Returns:

Throws:

BPMException

getActiveInstancesAsOfQueryId

@Deprecated
java.util.List<IAuditInstance> getActiveInstancesAsOfQueryId(IBPMContext context,
                                                                        long queryId)
                                                             throws BPMException

Deprecated.

Returns all audit instances for a as of give query ID.

Parameters:

queryId -

Returns:

Throws:

BPMException

See Also:

queryAuditInstances(oracle.bpel.services.bpm.common.IBPMContext, int, int, boolean, int, java.util.Calendar, long)

getAllInstancesAfterQueryId

@Deprecated
java.util.List<IAuditInstance> getAllInstancesAfterQueryId(IBPMContext context,
                                                                      long queryId)
                                                           throws BPMException

Deprecated.

Returns all audit instances after query ID

Parameters:

queryId -

Returns:

Throws:

BPMException

See Also:

queryAuditInstances(oracle.bpel.services.bpm.common.IBPMContext, int, int, boolean, int, java.util.Calendar, long)

queryAuditInstances

@NotNull
java.util.List<IAuditInstance> queryAuditInstances(IBPMContext context,
                                                           int firstResult,
                                                           int resultPageSize,
                                                           boolean active,
                                                           int totalResults,
                                                           java.util.Calendar referenceTime,
                                                           long backTrackTime)
                                                   throws BPMException

Returns a paged list of IAuditInstance records. The type records to be returned is based on the active flag. Set to true, one the IAuditInstance records will be returned that belong to processes that are still active i.e. do not contain any termination or end message. rangeSize specifies the maximum number of records to be returned overall. Whereas the daysBack parameter specifies how many days back to search. For both rangeSize and daysBack, specifying a 0 (zero) will result in that parameter being ignored.

Parameters:

firstResult - - The integer to desigate the starting point for the paged result. Use 0 (zero) for the first page.

resultPageSize - - The page size

active - - Flag to return the audit records for active (incomplete process) instances or inactive (complete) process instances.

totalResults - - The maximum number of IAuditInstance records to return if available.

backTrackTime - - The time in milli seconds worth of IAuditInstance records to return.

Returns:

The paged list of IAuditInstance

Throws:

BPMException

queryAuditInstances

java.util.List<IAuditInstance> queryAuditInstances(IBPMContext context,
                                                   java.lang.String expression)
                                                   throws BPMException

Returns a List of IAuditInstance based on the JPQL Expression. The JPQL expression can be built with the assitance of the IAuditConstants for the correct entity/field names.
Example:
String expression = IAuditContants.COLUMN_COMPOSITEINSTANCEID + " = 1000 "; This method is intended as a basic form of querying only.

Parameters:

context -

expression -

Returns:

Throws:

BPMException

queryAuditInstances

java.util.List<IAuditInstance> queryAuditInstances(IBPMContext context,
                                                   java.lang.String expression,
                                                   java.util.Map<java.lang.String,java.lang.Object> parameters)
                                                   throws BPMException

Returns a List of IAuditInstance based on the JPQL Expression and a Map of parameters and values. The JPQL expression can be built with the assitance of the IAuditConstants for the correct entity/field names. The creation of the parameter names should match those being provided in the Map of parameters.
Example:
String expression = IAuditContants.COLUMN_COMPOSITEINSTANCEID + " = :compositeId "; parameters.add("compositeId", "1000");

Parameters:

context -

expression -

parameters -

Returns:

Throws:

BPMException

queryAuditInstances

java.util.List<IAuditInstance> queryAuditInstances(IBPMContext context,
                                                   java.lang.String tablePrefix,
                                                   java.lang.String expression,
                                                   java.lang.String orderBy,
                                                   java.util.Map<java.lang.String,java.lang.Object> parameters,
                                                   int pageStart,
                                                   int pageSize)
                                                   throws BPMException

Returns a List of IAuditInstance based on the JPQL expression. The list will be ordered as specificed by the orderBy expression, a comma seperated list of AuditQuery fields. The list will also be paged based on the start row and the maximum result size. tablePrefix, if specified as null, will be interpreted as "aq.". pageStart and pageSize, when set to zero (0) will return a list of all results.

Parameters:

context -

tablePrefix - - Set this to indicate what prefix is used for the AuditQuery in the expression and orderBy if this is not "aq.".

expression - - The JPQL Where clause for the final SQL statement

orderBy - - The comma seperated list of AuditQuery fields

parameters - - A Map of parameter name, value pairs.

pageStart - - The row number that the query should start at

pageSize - - The Maximum number of rows to return in the query

Returns:

Throws:

BPMException

getAuditInstancePayload

@Deprecated
byte[] getAuditInstancePayload(IBPMContext ctx,
                                          long queryId)
                               throws BPMException

Deprecated.

Given a query ID, this method will return the audit detail XML that are attached to a particular task. (Internal use only).

Parameters:

ctx -

queryId -

Returns:

Throws:

BPMException

getAuditInstancePayloadXML

java.lang.String getAuditInstancePayloadXML(IBPMContext ctx,
                                            long queryId)
                                            throws BPMException

Given a query ID, this method will return the audit detail XML that are attached to a particular task.

Parameters:

ctx -

queryId -

Returns:

Throws:

BPMException

createGrabInstanceContext

IGrabInstanceContextResponse createGrabInstanceContext(IBPMContext context,
                                                       IGrabInstanceContextRequest grabInstanceContextRequest)
                                                       throws BPMException

Throws:

BPMException

findGrabInstanceContextForActivity

IGrabInstanceContext findGrabInstanceContextForActivity(IBPMContext context,
                                                        IProcessInstance instance,
                                                        IOpenActivityInfo openActivity,
                                                        IInstanceContextConfiguration configuration)
                                                        throws BPMException

Throws:

BPMException

createGrabMultipleInstancesContext

IGrabMultipleInstancesContextResponse createGrabMultipleInstancesContext(IBPMContext context,
                                                                         IGrabMultipleInstancesContextRequest grabMultipleInstancesContextRequest)
                                                                         throws BPMException

Throws:

BPMException

createMigrateInstanceContext

IMigrateInstanceContextResponse createMigrateInstanceContext(IBPMContext context,
                                                             IMigrateInstanceContextRequest migrateInstanceContextRequest)
                                                             throws BPMException

Throws:

BPMException

createMigrateMultipleInstancesContext

IMigrateMultipleInstancesContextResponse createMigrateMultipleInstancesContext(IBPMContext context,
                                                                               IMigrateMultipleInstancesContextRequest migrateMultipleInstancesContextRequest)
                                                                               throws BPMException

Throws:

BPMException

getComponentsPendingMigration

java.lang.Iterable<java.lang.String> getComponentsPendingMigration(IBPMContext context)
                                                                   throws BPMException

Throws:

BPMException

getCountOfInstancesPendingMigration

int getCountOfInstancesPendingMigration(IBPMContext context,
                                        java.lang.String processDN)
                                        throws BPMException

Throws:

BPMException

getProcessInstancesPendingMigration

java.lang.Iterable<IProcessInstance> getProcessInstancesPendingMigration(IBPMContext context,
                                                                         java.lang.String processDN,
                                                                         int startRow,
                                                                         int endRow)
                                                                         throws BPMException

Throws:

BPMException

getCountOfProcessInstances

int getCountOfProcessInstances(IBPMContext context,
                               java.lang.String processDN)
                               throws BPMException

Throws:

BPMException

getProcessAuditDiagram

java.lang.String getProcessAuditDiagram(IBPMContext bpmContext,
                                        java.lang.String instanceId,
                                        java.util.Locale locale)
                                        throws BPMException

Given a process instance id creates the process audit image

Parameters:

bpmContext -

instanceId -

locale -

Returns:

Image in PNG format and base64 coded

Throws:

BPMException - in case of image generation or process load error

getProcessDiagram

java.lang.String getProcessDiagram(IBPMContext bpmContext,
                                   java.lang.String instanceId,
                                   java.util.Locale locale)
                                   throws BPMException

Given a process instance id creates the process image

Parameters:

bpmContext -

instanceId -

locale -

Returns:

Image in PNG format and base64 coded

Throws:

BPMException - in case of image generation or process load error

Skip navigation links