001: /*--
002:
003: Copyright (C) 2002-2005 Adrian Price.
004: All rights reserved.
005:
006: Redistribution and use in source and binary forms, with or without
007: modification, are permitted provided that the following conditions
008: are met:
009:
010: 1. Redistributions of source code must retain the above copyright
011: notice, this list of conditions, and the following disclaimer.
012:
013: 2. Redistributions in binary form must reproduce the above copyright
014: notice, this list of conditions, and the disclaimer that follows
015: these conditions in the documentation and/or other materials
016: provided with the distribution.
017:
018: 3. The names "OBE" and "Open Business Engine" must not be used to
019: endorse or promote products derived from this software without prior
020: written permission. For written permission, please contact
021: adrianprice@sourceforge.net.
022:
023: 4. Products derived from this software may not be called "OBE" or
024: "Open Business Engine", nor may "OBE" or "Open Business Engine"
025: appear in their name, without prior written permission from
026: Adrian Price (adrianprice@users.sourceforge.net).
027:
028: THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
029: WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
030: OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
031: DISCLAIMED. IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT,
032: INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
033: (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
034: SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
035: HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
036: STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
037: IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
038: POSSIBILITY OF SUCH DAMAGE.
039:
040: For more information on OBE, please see
041: <http://obe.sourceforge.net/>.
042:
043: */
044:
045: package org.obe.spi.model;
046:
047: import org.obe.client.api.model.ActivityInstanceAttributes;
048: import org.obe.util.ClassUtils;
049:
050: import java.beans.PropertyDescriptor;
051: import java.util.Collection;
052: import java.util.Date;
053:
054: /**
055: * Holds the persistent state of an activity instance. This interface
056: * uses only standard Java data types; it does not need to know about
057: * WAPI data types - conversions are handled externally to the persistence
058: * service. No parameter validation need be performed by implementations.
059: *
060: * @author Adrian Price
061: * @see ActivityInstanceAttributes
062: */
063: public interface ActivityInstance extends AttributedEntity {
064: /**
065: * Property descriptors for ActivityInstance.
066: * <em>N.B. DO NOT WRITE TO THIS ARRAY!!!</em>
067: */
068: PropertyDescriptor[] propertyDescriptors = ClassUtils.introspect(
069: ActivityInstance.class, AttributedEntity.class);
070:
071: /**
072: * Attributes for ActivityInstance.
073: * <em>N.B. DO NOT WRITE TO THIS ARRAY!!!</em>
074: */
075: String[] attributes = ClassUtils
076: .getPropertyNames(propertyDescriptors);
077:
078: String getActivityDefinitionId();
079:
080: String getActivityInstanceId();
081:
082: /**
083: * Returns the ID of the encompassing block activity instance.
084: * N.B. This returns the activity instance ID, not the ActivitySet ID.
085: *
086: * @return The block activity instance ID, or <code>null</code> if this
087: * activity is not defined within an activity set.
088: */
089: String getBlockActivityInstanceId();
090:
091: /**
092: * Returns an iterator for the block activity owned by the instance.
093: * The iterator returned is persistence-capable, and can resume iteration
094: * through a supplied array. This feature is required to support the
095: * ForEach, Until, and While explicit iteration constructs in an
096: * asynchronous mode.
097: *
098: * @return A persistent iterator.
099: * @see PersistentIterator
100: */
101: PersistentIterator getBlockActivityIterator();
102:
103: int getState();
104:
105: void setState(int state);
106:
107: int getPriority();
108:
109: void setPriority(int priority);
110:
111: Date getStartedDate();
112:
113: void setStartedDate(Date startedDate);
114:
115: Date getCompletedDate();
116:
117: void setCompletedDate(Date completedDate);
118:
119: Date getTargetDate();
120:
121: void setTargetDate(Date targetDate);
122:
123: Date getDueDate();
124:
125: void setDueDate(Date dueDate);
126:
127: JoinInstance getJoin();
128:
129: String getName();
130:
131: void setName(String name);
132:
133: String[] getParticipants();
134:
135: void setParticipants(String[] participants);
136:
137: /**
138: * Returns the process instance to which this activity belongs.
139: *
140: * @return The process instance.
141: */
142: ProcessInstance getProcessInstance();
143:
144: /**
145: * Returns a collection of sub-process instance(s) associated
146: * with a SubFlow-implementation activity. For synchronous
147: * sub-flow activities, the collection will contain at most one open process
148: * instance; any others will be in the closed state. Asynchronous subflow
149: * activities can have any number of open subflow instances. Only subflow
150: * activities in loops will have multiple child process instances.
151: *
152: * @return An immutable collection of process instances.
153: */
154: Collection getChildProcessInstances();
155:
156: // /**
157: // * Creates a sub-process instance as a child of this activity instance.
158: // *
159: // * @param processDefinitionId The ID of the subflow's process definition.
160: // * @param instanceName The name of the subflow process instance.
161: // * @param priority The subflow process priority.
162: // * @param state The subflow process state.
163: // * @param createdDate The date/time of subflow process creation.
164: // * @param startedDate The date/time at which the subflow was started.
165: // * @param participants The participants for the subflow.
166: // * @return The child sub-flow.
167: // * @throws RepositoryException
168: // */
169: // ProcessInstance addChildProcessInstance(String processDefinitionId,
170: // String instanceName, int priority, int state, Date createdDate,
171: // Date startedDate, String[] participants) throws RepositoryException;
172:
173: /**
174: * Returns a collection of work items for this activity.
175: *
176: * @return An immutable collection of work items.
177: */
178: Collection getWorkItems();
179:
180: // /**
181: // * Creates a new work item for this activity.
182: // *
183: // * @param state
184: // * @param performer
185: // * @param participant
186: // * @return A new WorkItem object
187: // * @throws RepositoryException
188: // */
189: // WorkItem addWorkItem(int state, String performer, String participant)
190: // throws RepositoryException;
191: }
|