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.WMProcessInstance;
049:
050: import java.util.Date;
051:
052: /**
053: * An extended process instance interface that exposes all OBE process
054: * instance system attributes directly. OBE returns instances of this
055: * interface from the {@link WAPI#getProcessInstance} and
056: * {@link WAPI#listProcessInstances} methods.
057: *
058: * @author Adrian Price
059: */
060: public interface OBEProcessInstance extends WMProcessInstance {
061: /**
062: * @see ProcessInstanceAttributes#ACTIVITY_DUE_DATE
063: */
064: Date getActivityDueDate();
065:
066: /**
067: * @see ProcessInstanceAttributes#ACTIVITY_TARGET_DATE
068: */
069: Date getActivityTargetDate();
070:
071: /**
072: * The temporal status of the 'most critical' activity instance.
073: *
074: * @see ProcessInstanceAttributes#TEMPORAL_STATUS
075: */
076: TemporalStatus getActivityTemporalStatus();
077:
078: /**
079: * @see ProcessInstanceAttributes#COMPLETED_DATE
080: */
081: Date getCompletedDate();
082:
083: /**
084: * @see ProcessInstanceAttributes#CREATED_DATE
085: */
086: Date getCreatedDate();
087:
088: /**
089: * @see ProcessInstanceAttributes#DUE_DATE
090: */
091: Date getDueDate();
092:
093: /**
094: * @see ProcessInstanceAttributes#PARENT_ACTIVITY_INSTANCE_ID
095: */
096: String getParentActivityInstanceId();
097:
098: /**
099: * @see ProcessInstanceAttributes#PARENT_PROCESS_INSTANCE_ID
100: */
101: String getParentProcessInstanceId();
102:
103: /**
104: * @see ProcessInstanceAttributes#PROCESS_INSTANCE_ID
105: */
106: String getProcessInstanceId();
107:
108: /**
109: * @see ProcessInstanceAttributes#STARTED_DATE
110: */
111: Date getStartedDate();
112:
113: /**
114: * @see ProcessInstanceAttributes#TARGET_DATE
115: */
116: Date getTargetDate();
117:
118: /**
119: * @see ProcessInstanceAttributes#TEMPORAL_STATUS
120: */
121: TemporalStatus getTemporalStatus();
122: }
|