Source code: org/jbpm/workflow/execution/AttributeInstance.java
1 package org.jbpm.workflow.execution;
2
3 import org.jbpm.workflow.definition.*;
4
5 /**
6 * is a process-variable associated with one process instance.
7 * The value can be changed during the execution of the flow in following ways :
8 * <ul>
9 * <li><b>field input</b> : In the {@link ProcessDefinition},
10 * a {@link Field} associates an attribute with an {@link Activity}.
11 * When an actor performs that {@link Activity}, it has to provide input
12 * for the attribute. The value that is provided by the actor is stored in the
13 * AttributeInstance.</li>
14 * <li><b>interaction</b> : In every {@link org.jbpm.workflow.delegation.Interaction}-implementation
15 * the implementor has read & write access to all AttributeInstances through the
16 * {@link org.jbpm.workflow.delegation.InteractionContext}.</li>
17 * <li><b>role association</b> : A special kind of AttributeInstances is the
18 * role-attribute-instance. They are specified by the actorName-property in
19 * the activity. If an actor performs an activity, the attribute-instance with name
20 * actorName is set to the actor.</li>
21 * </ul>
22 * @author Tom Baeyens
23 */
24 public interface AttributeInstance extends java.io.Serializable {
25
26 /**
27 * the meaningless primary-key for this object.
28 */
29 Long getId();
30
31 /**
32 * is the java-object-value for this AttributeInstance.
33 */
34 Object getValue();
35
36 /**
37 * gets the text as it is store in the database in serialized form.
38 */
39 String getValueText();
40
41 /**
42 * is the {@link Attribute} of this AttributeInstance.
43 */
44 Attribute getAttribute();
45
46 /**
47 * is the {@link Flow} to which this AttributeInstance is associated.
48 */
49 Flow getScope();
50 }