1 /**
2 * Copyright 2005-2012 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.krms.api.engine;
17
18 import java.util.List;
19
20 /**
21 * Results of an @{link Engine}'s execution
22 *
23 * @author Kuali Rice Team (rice.collab@kuali.org)
24 */
25 public interface EngineResults {
26
27 // TODO - need to determine what goes here...
28
29 /**
30 * Return the ResultEvent for the given index
31 * @param index
32 * @return {@link ResultEvent}
33 */
34 public ResultEvent getResultEvent(int index);
35
36 /**
37 * Return the list of ResultEvents
38 * @return List<ResultEvent>
39 */
40 public List<ResultEvent> getAllResults();
41
42 /**
43 * Return the ResultEvents of the given type
44 * @param type
45 * @return List<ResultEvent>
46 */
47 public List<ResultEvent> getResultsOfType(String type);
48
49 /**
50 * Return the attribute of the given key
51 * @param key
52 * @return Object
53 */
54 public Object getAttribute(String key);
55
56 /**
57 * Set the attribute of the given values
58 * @param key
59 * @param attribute
60 */
61 public void setAttribute(String key, Object attribute);
62
63 /**
64 * Add the given result
65 * @param result
66 */
67 public void addResult(ResultEvent result);
68 }