001: /*
002: * This file is part of the WfMOpen project.
003: * Copyright (C) 2001-2003 Danet GmbH (www.danet.de), GS-AN.
004: * All rights reserved.
005: *
006: * This program is free software; you can redistribute it and/or modify
007: * it under the terms of the GNU General Public License as published by
008: * the Free Software Foundation; either version 2 of the License, or
009: * (at your option) any later version.
010: *
011: * This program is distributed in the hope that it will be useful,
012: * but WITHOUT ANY WARRANTY; without even the implied warranty of
013: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
014: * GNU General Public License for more details.
015: *
016: * You should have received a copy of the GNU General Public License
017: * along with this program; if not, write to the Free Software
018: * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
019: *
020: * $Id: WfAuditEvent.java,v 1.2 2006/09/29 12:32:09 drmlipp Exp $
021: *
022: * $Log: WfAuditEvent.java,v $
023: * Revision 1.2 2006/09/29 12:32:09 drmlipp
024: * Consistently using WfMOpen as projct name now.
025: *
026: * Revision 1.1.1.1 2003/06/30 20:05:16 drmlipp
027: * Initial import
028: *
029: * Revision 1.13 2003/06/27 08:51:45 lipp
030: * Fixed copyright/license information.
031: *
032: * Revision 1.12 2003/04/26 16:11:14 lipp
033: * Moved some classes to reduce package dependencies.
034: *
035: * Revision 1.11 2002/10/02 11:12:08 barzik
036: * implemented constants for event types
037: *
038: * Revision 1.10 2002/10/01 09:10:39 lipp
039: * AuditEvent handling restructured.
040: *
041: * Revision 1.9 2002/10/01 06:45:23 barzik
042: * no message
043: *
044: * Revision 1.8 2002/09/30 15:04:46 lipp
045: * Added implements Serializable.
046: *
047: * Revision 1.7 2002/09/30 12:42:05 barzik
048: * audit event handling using base event information
049: *
050: * Revision 1.6 2002/09/26 09:53:00 huaiyang
051: * In readresolve method use text representation to compare.
052: *
053: * Revision 1.5 2002/09/26 08:02:31 barzik
054: * Moved EventType to WfAuditEvent.java
055: *
056: * Revision 1.4 2002/09/24 12:23:36 barzik
057: * Extended ...
058: *
059: * Revision 1.3 2002/07/24 08:04:42 huaiyang
060: * doccheck.
061: *
062: * Revision 1.2 2001/08/24 12:58:30 lipp
063: * CR/NL fixes
064: *
065: * Revision 1.1 2001/07/06 08:51:48 lipp
066: * Moved from domain to omgcore
067: *
068: * Revision 1.1 2001/07/05 14:15:09 lipp
069: * Rather complete version.
070: *
071: */
072: package de.danet.an.workflow.omgcore;
073:
074: import java.util.Date;
075:
076: /**
077: * <P>A <code>WfAuditEvent</code> provides an audit record of workflow event
078: * information.</P>
079: * <P>It provides information on the source of the event and contains
080: * specific event data. Workflow events include state changes, change of a
081: * resource assignment, and data changes. Workflow events are persistent and
082: * can be accessed navigating the history relationship of a
083: * <code>WfExecutionObject</code>.</P>
084: * <P>Workflow audit event objects are not part of the persistent state of
085: * their source workflow object.</P>
086: */
087: public interface WfAuditEvent {
088:
089: /**
090: * An identifier for the event type "processCreated"
091: */
092: public static final String PROCESS_CREATED = "processCreated";
093:
094: /**
095: * An identifier for the event type "processStateChanged"
096: */
097: public static final String PROCESS_STATE_CHANGED = "processStateChanged";
098:
099: /**
100: * An identifier for the event type "processContextChanged"
101: */
102: public static final String PROCESS_CONTEXT_CHANGED = "processContextChanged";
103:
104: /**
105: * An identifier for the event type "activityStateChanged"
106: */
107: public static final String ACTIVITY_STATE_CHANGED = "activityStateChanged";
108:
109: /**
110: * An identifier for the event type "activityContextChanged"
111: */
112: public static final String ACTIVITY_CONTEXT_CHANGED = "activityContextChanged";
113:
114: /**
115: * An identifier for the event type "activityResultChanged"
116: */
117: public static final String ACTIVITY_RESULT_CHANGED = "activityResultChanged";
118:
119: /**
120: * An identifier for the event type "activityAssignmentChanged"
121: */
122: public static final String ACTIVITY_ASSIGNMENT_CHANGED = "activityAssignmentChanged";
123:
124: /**
125: * Returns the current value of the attribute <code>source</code>.
126: * The source of the event is the <code>WfExceutionObject</code>
127: * associated to the event, i.e. that triggered the event.
128: * @return the current value of the attribute.
129: * @throws SourceNotAvailableException if the source is not available.
130: */
131: WfExecutionObject source() throws SourceNotAvailableException;
132:
133: /**
134: * Returns the current value of the attribute <code>timeStamp</code>.
135: * @return the current value of the attribute.
136: */
137: Date timeStamp();
138:
139: /**
140: * Returns the current value of the attribute <code>eventType</code>.
141: * @return the current value of the attribute.
142: */
143: String eventType();
144:
145: /**
146: * Returns the current value of the attribute <code>activityKey</code>.
147: * @return the current value of the attribute.
148: */
149: String activityKey();
150:
151: /**
152: * Returns the current value of the attribute <code>activityName</code>.
153: * @return the current value of the attribute.
154: */
155: String activityName();
156:
157: /**
158: * Returns the current value of the attribute <code>processKey</code>.
159: * @return the current value of the attribute.
160: */
161: String processKey();
162:
163: /**
164: * Returns the current value of the attribute <code>processName</code>.
165: * @return the current value of the attribute.
166: */
167: String processName();
168:
169: /**
170: * Returns the current value of the attribute
171: * <code>processMgrName</code>.
172: * @return the current value of the attribute.
173: */
174: String processMgrName();
175:
176: /**
177: * Returns the current value of the attribute
178: * <code>processMgrVersion</code>.
179: * @return the current value of the attribute.
180: */
181: String processMgrVersion();
182:
183: }
|