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.WorkItemAttributes;
048: import org.obe.util.ClassUtils;
049:
050: import java.beans.PropertyDescriptor;
051: import java.util.Date;
052:
053: /**
054: * Holds the persistent state of a work item. This interface
055: * uses only standard Java data types; it does not need to know about
056: * WAPI data types - conversions are handled externally to the persistence
057: * service. No parameter validation need be performed by implementations.
058: *
059: * @author Adrian Price
060: * @author Anthony Eden
061: * @see WorkItemAttributes
062: */
063: public interface WorkItem extends AttributedEntity {
064: /**
065: * Property descriptors for WorkItem.
066: * <em>N.B. DO NOT WRITE TO THIS ARRAY!!!</em>
067: */
068: PropertyDescriptor[] propertyDescriptors = ClassUtils.introspect(
069: WorkItem.class, AttributedEntity.class);
070:
071: /**
072: * Attributes for WorkItem.
073: * <em>N.B. DO NOT WRITE TO THIS ARRAY!!!</em>
074: */
075: String[] attributes = ClassUtils
076: .getPropertyNames(propertyDescriptors);
077:
078: String getActivityInstanceId();
079:
080: String getActivityDefinitionId();
081:
082: String getWorkItemId();
083:
084: int getToolIndex();
085:
086: void setToolIndex(int index);
087:
088: int getState();
089:
090: void setState(int state);
091:
092: int getPriority();
093:
094: void setPriority(int priority);
095:
096: Date getStartedDate();
097:
098: void setStartedDate(Date startedDate);
099:
100: Date getCompletedDate();
101:
102: void setCompletedDate(Date completedDate);
103:
104: Date getTargetDate();
105:
106: void setTargetDate(Date targetDate);
107:
108: Date getDueDate();
109:
110: void setDueDate(Date dueDate);
111:
112: String getName();
113:
114: void setName(String name);
115:
116: String getParticipant();
117:
118: void setParticipant(String participant);
119:
120: String getPerformer();
121:
122: void setPerformer(String performer);
123:
124: /**
125: * Returns the parent activity instance for this work item.
126: *
127: * @return The parent ActivityInstance
128: */
129: ActivityInstance getActivityInstance();
130: }
|