KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > pentaho > core > solution > IActionSequence


1 /*
2  * Copyright 2006 Pentaho Corporation. All rights reserved.
3  * This software was developed by Pentaho Corporation and is provided under the terms
4  * of the Mozilla Public License, Version 1.1, or any later version. You may not use
5  * this file except in compliance with the license. If you need a copy of the license,
6  * please go to http://www.mozilla.org/MPL/MPL-1.1.txt. The Original Code is the Pentaho
7  * BI Platform. The Initial Developer is Pentaho Corporation.
8  *
9  * Software distributed under the Mozilla Public License is distributed on an "AS IS"
10  * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. Please refer to
11  * the license for the specific language governing your rights and limitations.
12  *
13  * @created Jul 18, 2005
14  * @author James Dixon
15  *
16  */
17 package org.pentaho.core.solution;
18
19 import java.util.List JavaDoc;
20
21 /**
22  * An ActionSequence is the functional object that wraps a SequenceDefinition
23  * for processing by the RuntimeContext. When a request results in a
24  * RuntimeContext execution, it is the ActionSequence that the context is
25  * operazting on.
26  *
27  */
28 public interface IActionSequence extends ISequenceDefinition {
29
30     /**
31      * Returns the list of ActionDefinition objects retrieved from the
32      * SequenceDefinition.
33      *
34      * @return list of ActionDefinitions
35      */
36     public List JavaDoc getActionDefinitionsAndSequences();
37
38     /**
39      * If the ActionSequence contains a loop, returns the parameter that the
40      * execution should loop on.
41      *
42      * @return the parameter to loop on, if looping is defined, otherwise null
43      */
44     public String JavaDoc getLoopParameter();
45
46     /**
47      * Returns whether the ActionSequence has a loop in its definition.
48      *
49      * @return true if looping is defined, otherwise false
50      */
51     public boolean hasLoop();
52     
53     /**
54      * @return The conditional execution object that determines whether a set
55      * of actions will be executed.
56      */
57     public ConditionalExecution getConditionalExecution();
58
59     /**
60      * Sets the ConditionalExecution object that determines whether a set of
61      * actions will be executed.
62      * @param value The ConditionalExecution object
63      */
64     public void setConditionalExecution(ConditionalExecution value);
65 }
66
Popular Tags