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.ProcessInstanceAttributes;
048:
049: import java.util.Collection;
050: import java.util.Date;
051:
052: /**
053: * Holds the persistent state of a workflow process instance. This interface
054: * uses only standard Java data types; it does not need to know about
055: * WAPI data types - conversions are handled externally to the persistence
056: * service. No parameter validation need be performed by implementations.
057: *
058: * @author Adrian Price
059: * @see ProcessInstanceAttributes
060: */
061: public interface ProcessInstance extends AttributedEntity {
062: int getState();
063:
064: void setState(int state);
065:
066: int getPriority();
067:
068: void setPriority(int priority);
069:
070: Date getCreatedDate();
071:
072: void setCreatedDate(Date createdDate);
073:
074: Date getActivityTargetDate();
075:
076: void setActivityTargetDate(Date targetDate);
077:
078: Date getActivityDueDate();
079:
080: void setActivityDueDate(Date dueDate);
081:
082: Date getTargetDate();
083:
084: void setTargetDate(Date targetDate);
085:
086: Date getDueDate();
087:
088: void setDueDate(Date dueDate);
089:
090: Date getStartedDate();
091:
092: void setStartedDate(Date startedDate);
093:
094: Date getCompletedDate();
095:
096: void setCompletedDate(Date completedDate);
097:
098: String getName();
099:
100: void setName(String name);
101:
102: String[] getParticipants();
103:
104: void setParticipants(String[] participants);
105:
106: /**
107: * Returns a collection of activity instances.
108: *
109: * @return An immutable collection of activity instances.
110: */
111: Collection getActivityInstances();
112:
113: /**
114: * Returns the activity instance that started this process as a subflow.
115: *
116: * @return The parent activity instance, or <code>null</code> if this
117: * process instance does not have a parent.
118: */
119: ActivityInstance getParentActivityInstance();
120:
121: String getParentActivityInstanceId();
122: }
|