KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > opensymphony > workflow > spi > Step


1 /*
2  * Copyright (c) 2002-2003 by OpenSymphony
3  * All rights reserved.
4  */
5 package com.opensymphony.workflow.spi;
6
7 import java.util.Date JavaDoc;
8
9
10 /**
11  * Interface for a step associated with a workflow instance.
12  *
13  * @author <a HREF="mailto:plightbo@hotmail.com">Pat Lightbody</a>
14  */
15 public interface Step {
16     //~ Methods ////////////////////////////////////////////////////////////////
17
18     /**
19      * Returns the ID of the action associated with this step,
20      * or 0 if there is no action associated.
21      */
22     public int getActionId();
23
24     public String JavaDoc getCaller();
25
26     /**
27      * Returns an optional date signifying when this step must be finished.
28      */
29     public Date JavaDoc getDueDate();
30
31     /**
32      * Returns the unique ID of the workflow entry.
33      */
34     public long getEntryId();
35
36     /**
37      * Returns the date this step was finished, or null if it isn't finished.
38      */
39     public Date JavaDoc getFinishDate();
40
41     /**
42      * Returns the unique ID of this step.
43      */
44     public long getId();
45
46     /**
47      * Returns the owner of this step, or null if there is no owner.
48      */
49     public String JavaDoc getOwner();
50
51     /**
52      * Returns the unique ID of the previous step, or 0 if this is the first step.
53      */
54     public long[] getPreviousStepIds();
55
56     /**
57      * Returns the date that this step was created.
58      */
59     public Date JavaDoc getStartDate();
60
61     /**
62      * Returns the status of this step.
63      */
64     public String JavaDoc getStatus();
65
66     /**
67      * Returns the ID of the step in the workflow definition.
68      */
69     public int getStepId();
70 }
71
Popular Tags