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