1 /**
2 * Copyright 2005-2011 The Kuali Foundation
3 *
4 * Licensed under the Educational Community License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.opensource.org/licenses/ecl2.php
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16 package org.kuali.rice.kew.framework.postprocessor;
17
18 import java.io.Serializable;
19
20
21
22 /**
23 * Base event interface for events emitted from the workflow engine
24 * and hooked by the {@link PostProcessor}
25 * @author Kuali Rice Team (rice.collab@kuali.org)
26 */
27 public interface IDocumentEvent extends Serializable {
28 public static final String ROUTE_LEVEL_CHANGE = "rt_lvl_change";
29 public static final String ROUTE_STATUS_CHANGE = "rt_status_change";
30 public static final String DELETE_CHANGE = "delete_document";
31 public static final String ACTION_TAKEN = "action_taken";
32 public static final String BEFORE_PROCESS = "before_process";
33 public static final String AFTER_PROCESS = "after_process";
34 public static final String LOCK_DOCUMENTS = "lock_documents";
35
36 /**
37 * @return the code of this document event
38 */
39 public String getDocumentEventCode();
40
41 /**
42 * @return the document id for which this event was generated
43 */
44 public String getDocumentId();
45
46 /**
47 * @return the application document id registered for this document when it was created
48 */
49 public String getAppDocId();
50 }