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.client.api.model;
046:
047: import org.wfmc.wapi.WAPI;
048: import org.wfmc.wapi.WMFilter;
049: import org.wfmc.wapi.WMWorkItemState;
050:
051: /**
052: * Describes the work item system attributes supported by OBE. The
053: * string constants in this interface can be passed to
054: * {@link WAPI#getWorkItemAttributeValue} and as the
055: * <code>attributeName</code> argument to
056: * {@link WMFilter#WMFilter(String,int,Boolean)}.
057: *
058: * @author Adrian Price
059: */
060: public class WorkItemAttributes {
061: /**
062: * The ID of the activity instance with which the work item is associated.
063: * <p/>
064: * <table border="1">
065: * <tr><th>Data Type</th><th>Access</th></tr>
066: * <tr><td><code>java.lang.String</code></td><td>ReadOnly</td></tr>
067: * </table>
068: */
069: public static final String ACTIVITY_INSTANCE_ID = "activityInstanceId";
070:
071: /**
072: * The date/time at which the work item was completed.
073: * <p/>
074: * <table border="1">
075: * <tr><th>Data Type</th><th>Access</th></tr>
076: * <tr><td><code>java.util.Date</code></td><td>ReadOnly</td></tr>
077: * </table>
078: */
079: public static final String COMPLETED_DATE = "completedDate";
080:
081: /**
082: * The date/time by which the work item must be complete.
083: * <p/>
084: * <table border="1">
085: * <tr><th>Data Type</th><th>Access</th></tr>
086: * <tr><td><code>java.util.Date</code></td><td>ReadOnly</td></tr>
087: * </table>
088: */
089: public static final String DUE_DATE = "dueDate";
090:
091: /**
092: * The name of the work item (copied from its activity instance).
093: * <p/>
094: * <table border="1">
095: * <tr><th>Data Type</th><th>Access</th></tr>
096: * <tr><td><code>java.lang.String</code></td><td>ReadOnly</td></tr>
097: * </table>
098: */
099: public static final String NAME = "name";
100:
101: /**
102: * The ID of the participant to whom the work item is assigned. This ID is
103: * the concrete participant name as resolved by the participant repository,
104: * as opposed to the (potentially) abstract performer declared in the
105: * activity definition.
106: * <p/>
107: * <table border="1">
108: * <tr><th>Data Type</th><th>Access</th></tr>
109: * <tr><td><code>java.lang.String</code></td><td>ReadOnly</td></tr>
110: * </table>
111: */
112: public static final String PARTICIPANT = "participant";
113:
114: /**
115: * The ID of the performer to whom the work item is assigned. This ID is
116: * the abstract performer declared in the activity definition.
117: * <p/>
118: * <table border="1">
119: * <tr><th>Data Type</th><th>Access</th></tr>
120: * <tr><td><code>java.lang.String</code></td><td>ReadOnly</td></tr>
121: * </table>
122: */
123: public static final String PERFORMER = "performer";
124:
125: /**
126: * The priority of the work item (copied from the activity instance).
127: * <p/>
128: * <table border="1">
129: * <tr><th>Data Type</th><th>Access</th></tr>
130: * <tr><td><code>int</code></td><td>Read/Write</td></tr>
131: * </table>
132: */
133: public static final String PRIORITY = "priority";
134:
135: /**
136: * The ID of the process definition that defines the work item's activity.
137: * <p/>
138: * <table border="1">
139: * <tr><th>Data Type</th><th>Access</th></tr>
140: * <tr><td><code>java.lang.String</code></td><td>ReadOnly</td></tr>
141: * </table>
142: */
143: public static final String PROCESS_DEFINITION_ID = "processDefinitionId";
144:
145: /**
146: * The ID of the process instance to which the work item belongs.
147: * <p/>
148: * <table border="1">
149: * <tr><th>Data Type</th><th>Access</th></tr>
150: * <tr><td><code>java.lang.String</code></td><td>ReadOnly</td></tr>
151: * </table>
152: */
153: public static final String PROCESS_INSTANCE_ID = "processInstanceId";
154:
155: /**
156: * The date/time at which the work item was started.
157: * <p/>
158: * <table border="1">
159: * <tr><th>Data Type</th><th>Access</th></tr>
160: * <tr><td><code>java.util.Date</code></td><td>ReadOnly</td></tr>
161: * </table>
162: */
163: public static final String STARTED_DATE = "startedDate";
164:
165: /**
166: * The state of the work item.
167: * <p/>
168: * <table border="1">
169: * <tr><th>Data Type</th><th>Access</th></tr>
170: * <tr><td><code>int</code></td><td>ReadOnly</td></tr>
171: * </table>
172: *
173: * @see WMWorkItemState
174: */
175: public static final String STATE = "state";
176:
177: /**
178: * The date/time by which the work item is expected to be complete.
179: * <p/>
180: * <table border="1">
181: * <tr><th>Data Type</th><th>Access</th></tr>
182: * <tr><td><code>java.util.Date</code></td><td>ReadOnly</td></tr>
183: * </table>
184: */
185: public static final String TARGET_DATE = "targetDate";
186:
187: /**
188: * The temporal status of the work item.
189: * <p/>
190: * <table border="1">
191: * <tr><th>Data Type</th><th>Access</th></tr>
192: * <tr><td><code>org.obe.client.api.model.TemporalStatus</code></td><td>ReadOnly</td></tr>
193: * </table>
194: */
195: public static final String TEMPORAL_STATUS = "temporalStatus";
196:
197: /**
198: * The index of the tool associated with the work item.
199: * <p/>
200: * <table border="1">
201: * <tr><th>Data Type</th><th>Access</th></tr>
202: * <tr><td><code>int</code></td><td>ReadOnly</td></tr>
203: * </table>
204: */
205: public static final String TOOL_INDEX = "toolIndex";
206:
207: /**
208: * The unique ID of the work item.
209: * <p/>
210: * <table border="1">
211: * <tr><th>Data Type</th><th>Access</th></tr>
212: * <tr><td><code>java.lang.String</code></td><td>ReadOnly</td></tr>
213: * </table>
214: */
215: public static final String WORKITEM_ID = "workItemId";
216:
217: private WorkItemAttributes() {
218: }
219: }
|