1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
/*
 * JBoss, Home of Professional Open Source
 * Copyright 2005, JBoss Inc., and individual contributors as indicated
 * by the @authors tag. See the copyright.txt in the distribution for a
 * full listing of individual contributors.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.jbpm.api;
 
import java.util.List;
 
 
/** query for {@link ProcessInstance process instances}.
 * 
 * @author Tom Baeyens
 */
public interface ProcessInstanceQuery {
  
  /** key property to be used as property in {@link #orderAsc(String)} and {@link #orderDesc(String)} */
  String PROPERTY_KEY = "key";
  
  /** select only process instances for the given process definition */
  ProcessInstanceQuery processDefinitionId(String processDefinitionId);
 
  /** select only a specific process instances using the process instance id */
  ProcessInstanceQuery processInstanceId(String processInstanceId);
  
  /** select only specific process instances using a business key */
  ProcessInstanceQuery processInstanceKey(String processInstanceKey);
 
  /** select only suspended process definitions */
  ProcessInstanceQuery suspended();
 
  /** select only process definitions that are not suspended */
  ProcessInstanceQuery notSuspended();
 
  /** order selected process instances ascending for certain {@link #PROPERTY_KEY properties} */
  ProcessInstanceQuery orderAsc(String property);
 
  /** order selected process instances descending for certain {@link #PROPERTY_KEY properties} */
  ProcessInstanceQuery orderDesc(String property);
 
  /** select a specific page in the result set */
  ProcessInstanceQuery page(int firstResult, int maxResults);
 
  /** execute the query and obtain the list of {@link ProcessInstance}s */
  List<ProcessInstance> list();
 
  /** execute the query and obtain the unique {@link ProcessInstance} */
  ProcessInstance uniqueResult();
  
  /** execute a count(*) query and returns number of results */ 
  long count();
}