|
Oracle Fusion Middleware Java API Reference for Oracle BPM Suite 11g Release 1 (11.1.1.7.0) E25378-07 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IInstanceQueryService
This interface provides methods to query Process Instances using different criteria and access Process Instance data. A set of methods is provided to get Process Instance information to use before proceeding with Migration and Alter Flow. The information contains Data Objects visible by the instance, and source activities with a set of valid targets to move the instance to.
Method Summary | |
---|---|
IGrabInstanceContextResponse |
createGrabInstanceContext(IBPMContext context,
IGrabInstanceContextRequest grabInstanceContextRequest)
createGrabInstanceContext lets you create the context to grab, this operation collects all the data needed to do a grab on a process instance (open activities, data objects, etc). |
IGrabMultipleInstancesContextResponse |
createGrabMultipleInstancesContext(IBPMContext context,
IGrabMultipleInstancesContextRequest grabMultipleInstancesContextRequest)
createGrabMultipleInstancesContext lets you create a context to grab multiple process instances. |
IMigrateInstanceContextResponse |
createMigrateInstanceContext(IBPMContext context,
IMigrateInstanceContextRequest migrateInstanceContextRequest)
Create the context to grab, this operation collects all the data needed to migrate on a process instance (open activities, data objects, etc). |
IMigrateMultipleInstancesContextResponse |
createMigrateMultipleInstancesContext(IBPMContext context,
IMigrateMultipleInstancesContextRequest migrateMultipleInstancesContextRequest)
createMigrateMultipleInstancesContext lets you create a context to migrate multiple process instances. |
java.io.Serializable |
fetchVariableValue(ILocationInfo location,
IVariableItem variable)
|
IGrabInstanceContext |
findGrabInstanceContextForActivity(IBPMContext context,
IProcessInstance instance,
IOpenActivityInfo openActivity,
IInstanceContextConfiguration configuration)
findGrabInstanceContextForActivity finds the grab instance context of the openActivity with the state of all its ancestors context, according to the information provided by configuration object. |
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)
getComponentsPendingMigration gets an Iterable of Process DN for the components that have instances pending to migrate. |
int |
getCountOfInstancesPendingMigration(IBPMContext context,
java.lang.String processDN)
getCountOfInstancesPendingMigration gets the number of instances that are pending migration for the specified process. |
int |
getCountOfProcessInstances(IBPMContext context,
java.lang.String processDN)
getCountOfProcessInstances gets the total number of instances for the specified Process DN. |
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)
getProcessInstancesPendingMigration gets an Iterable of Process Instances for the specified component that are pending migration. |
java.util.List<IAuditInstance> |
queryAuditInstanceByActivityId(IBPMContext context,
java.util.List<IAuditInstance> auditInstances,
java.lang.String activityId)
Returns the audit instances relating to the activity ID within the audit instances contains in auditInstances. |
java.util.List<IAuditInstance> |
queryAuditInstanceByActivityId(IBPMContext context,
java.lang.String processId,
java.lang.String activityId)
Returns the audit instances relating to the activity ID in the instance identified by the process ID. |
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 |
---|
java.util.List<IAuditInstance> queryAuditInstanceByActivityId(IBPMContext context, java.util.List<IAuditInstance> auditInstances, java.lang.String activityId) throws BPMException
context
- auditInstances
- activityId
-
BPMException
java.util.Map<java.lang.String,java.lang.String> getActivityTypes(IBPMContext context, java.lang.String compositeDN, java.lang.String componentName) throws BPMException
context
- compositeDN
- componentName
-
BPMException
java.util.List<IProcessInstance> queryViewInstances(IBPMContext context, java.lang.String viewId, Predicate extraPredicate, Ordering ordering, int startRow, int endRow) throws BPMException
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.
BPMException
java.util.List<IProcessInstance> queryViewProcessInstances(IBPMContext context, java.lang.String viewId, Predicate extraPredicate, Ordering ordering, int startRow, int endRow) throws BPMException
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.
BPMException
java.util.List<java.lang.String> getInstancesActedByAssignee(IBPMContext context, java.util.Calendar startDate, java.util.Calendar endDate) throws BPMException
context
- startDate
- endDate
-
BPMException
java.util.List<IProcessInstanceUser> getInstanceUpdatedUserHistoryByInstanceId(IBPMContext context, java.lang.String instanceId) throws BPMException
context
- instanceId
-
BPMException
java.util.List<IProcessInstanceUser> getInstanceUpdatedUserHistoryByTaskNumber(IBPMContext context, int taskNumber) throws BPMException
context
- taskNumber
-
BPMException
java.util.List<IProcessComment> getProcessComments(IBPMContext context, IProcessInstance instance) throws BPMException
context
- instance
-
BPMException
java.util.List<IProcessAttachment> getProcessAttachments(IBPMContext context, IProcessInstance instance) throws BPMException
context
- instance
-
BPMException
java.util.List<IProcessInstance> queryParallelInstances(IBPMContext context, IProcessInstance instance, java.util.List<Column> displayColumns) throws BPMException
BPMException
java.util.List<IProcessInstance> queryInstances(IBPMContext context, java.util.List<Column> displayColumns, Predicate predicate, Ordering ordering, IInstanceQueryInput queryInput) throws BPMException
context
- displayColumns
- predicate
- ordering
- queryInput
-
BPMException
java.util.List<IProcessInstance> queryProcessInstances(IBPMContext context, java.util.List<Column> displayColumns, Predicate predicate, Ordering ordering, IInstanceQueryInput queryInput) throws BPMException
context
- displayColumns
- predicate
- ordering
- queryInput
-
BPMException
IProcessInstance getProcessInstance(IBPMContext context, int processNumber) throws BPMException
context
- processNumber
-
BPMException
IProcessInstance getProcessInstance(IBPMContext context, java.lang.String processId) throws BPMException
context
- processId
-
BPMException
java.util.List<IAuditInstance> queryAuditInstanceByProcessId(IBPMContext context, java.lang.String instanceId) throws BPMException
instanceId
-
BPMException
java.util.List<IAuditInstance> queryAuditInstanceByActivityId(IBPMContext context, java.lang.String processId, java.lang.String activityId) throws BPMException
context
- processId
- activityId
-
BPMException
@Deprecated java.util.List<IAuditInstance> getActiveInstancesAsOfQueryId(IBPMContext context, long queryId) throws BPMException
queryId
-
BPMException
queryAuditInstances(oracle.bpel.services.bpm.common.IBPMContext, int, int, boolean, int, java.util.Calendar, long)
@Deprecated java.util.List<IAuditInstance> getAllInstancesAfterQueryId(IBPMContext context, long queryId) throws BPMException
queryId
-
BPMException
queryAuditInstances(oracle.bpel.services.bpm.common.IBPMContext, int, int, boolean, int, java.util.Calendar, long)
@NotNull java.util.List<IAuditInstance> queryAuditInstances(IBPMContext context, int firstResult, int resultPageSize, boolean active, int totalResults, java.util.Calendar referenceTime, long backTrackTime) throws BPMException
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.
firstResult
- - The integer to desigate the starting point for the
paged result. Use 0 (zero) for the first page.resultPageSize
- - The page sizeactive
- - 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.
BPMException
java.util.List<IAuditInstance> queryAuditInstances(IBPMContext context, java.lang.String expression) throws BPMException
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.
String expression = IAuditContants.COLUMN_COMPOSITEINSTANCEID + " = 1000 ";
This method is intended as a basic form of querying only.
context
- expression
-
BPMException
java.util.List<IAuditInstance> queryAuditInstances(IBPMContext context, java.lang.String expression, java.util.Map<java.lang.String,java.lang.Object> parameters) throws BPMException
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.
String expression = IAuditContants.COLUMN_COMPOSITEINSTANCEID + " = :compositeId ";
parameters.add("compositeId", "1000");
context
- expression
- parameters
-
BPMException
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
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.
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 statementorderBy
- - The comma seperated list of AuditQuery fieldsparameters
- - A Map
of parameter name, value pairs.pageStart
- - The row number that the query should start atpageSize
- - The Maximum number of rows to return in the query
BPMException
@Deprecated byte[] getAuditInstancePayload(IBPMContext ctx, long queryId) throws BPMException
ctx
- queryId
-
BPMException
java.lang.String getAuditInstancePayloadXML(IBPMContext ctx, long queryId) throws BPMException
ctx
- queryId
-
BPMException
IGrabInstanceContextResponse createGrabInstanceContext(IBPMContext context, IGrabInstanceContextRequest grabInstanceContextRequest) throws BPMException
context
- bpm identity context.grabInstanceContextRequest
- the grab request of the process instance context creation.
BPMException
IGrabInstanceContext findGrabInstanceContextForActivity(IBPMContext context, IProcessInstance instance, IOpenActivityInfo openActivity, IInstanceContextConfiguration configuration) throws BPMException
context
- bpm identity context.instance
- the target process instance.openActivity
- the target open activity.configuration
- the configuration that specifies which information regarding the instance state should be included in the grab instance context.
BPMException
IGrabMultipleInstancesContextResponse createGrabMultipleInstancesContext(IBPMContext context, IGrabMultipleInstancesContextRequest grabMultipleInstancesContextRequest) throws BPMException
context
- bpm identity context.grabMultipleInstancesContextRequest
- the grab request of multiple process instance context creation.
BPMException
IMigrateInstanceContextResponse createMigrateInstanceContext(IBPMContext context, IMigrateInstanceContextRequest migrateInstanceContextRequest) throws BPMException
context
- bpm identity context.migrateInstanceContextRequest
- the migrate request of the process instance context creation.
BPMException
IMigrateMultipleInstancesContextResponse createMigrateMultipleInstancesContext(IBPMContext context, IMigrateMultipleInstancesContextRequest migrateMultipleInstancesContextRequest) throws BPMException
context
- bpm identity context.migrateMultipleInstancesContextRequest
- the migration request of multiple process instance context creation.
BPMException
java.lang.Iterable<java.lang.String> getComponentsPendingMigration(IBPMContext context) throws BPMException
context
- bpm identity context.
BPMException
int getCountOfInstancesPendingMigration(IBPMContext context, java.lang.String processDN) throws BPMException
context
- bpm identity context.processDN
- the Process DN for the component to query.
BPMException
java.lang.Iterable<IProcessInstance> getProcessInstancesPendingMigration(IBPMContext context, java.lang.String processDN, int startRow, int endRow) throws BPMException
context
- bpm identity context.processDN
- the Process DN to query instances.startRow
- the start of the page.endRow
- the end of the page.
BPMException
int getCountOfProcessInstances(IBPMContext context, java.lang.String processDN) throws BPMException
context
- bpm identity context,processDN
- the Process DN to query.
BPMException
java.lang.String getProcessAuditDiagram(IBPMContext bpmContext, java.lang.String instanceId, java.util.Locale locale) throws BPMException
bpmContext
- instanceId
- locale
-
BPMException
- in case of image generation or process load errorjava.lang.String getProcessDiagram(IBPMContext bpmContext, java.lang.String instanceId, java.util.Locale locale) throws BPMException
bpmContext
- instanceId
- locale
-
BPMException
- in case of image generation or process load errorjava.io.Serializable fetchVariableValue(ILocationInfo location, IVariableItem variable) throws BPMException
BPMException
|
Oracle Fusion Middleware Java API Reference for Oracle BPM Suite 11g Release 1 (11.1.1.7.0) E25378-07 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |