View Javadoc
1   /*
2    * $Header: /cvsroot/sinon/sinon/src/java/eteg/sinon/core/Step.java,v 1.2 2005/06/21 14:25:08 thiagohp Exp $
3    * $Revision: 1.2 $
4    * $Date: 2005/06/21 14:25:08 $
5    * $Author: thiagohp $
6    *
7    * =============================================================================
8    *
9    * Copyright 2004-2005 Eteg Internet Ltda. (http://www.eteg.com.br)
10   *
11   * Licensed under the Apache License, Version 2.0 (the "License");
12   * you may not use this file except in compliance with the License.
13   * You may obtain a copy of the License at
14   *
15   *     http://www.apache.org/licenses/LICENSE-2.0
16   *
17   * Unless required by applicable law or agreed to in writing, software
18   * distributed under the License is distributed on an "AS IS" BASIS,
19   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
20   * See the License for the specific language governing permissions and
21   * limitations under the License.
22   */
23  package eteg.sinon.core;
24  
25  /***
26   * Interface implemented by classes that represent page processing steps.
27   * The current set of steps includes {@link PositioningStep} (steps
28   * that change the current position in the page), {@link DataExtraction}
29   * (extraction of data), {@link LoopStep} (execution of steps in loop), and
30   * {@link Action} (processing of another page).
31   *
32   * @author <a href="mailto:thiagohp at users.sourceforge.net">Thiago H. de Paula Figueiredo</a>
33   * @author Last modified by $Author: thiagohp $
34   * @version $Revision: 1.2 $
35   */
36  public interface Step {
37  
38      /***
39       * Tells if this step is a data extraction
40       * @return <code>true</code> if this step is a data extraction,
41       * <code>false</code> otherwise.
42       */
43      public boolean isDataExtraction();
44  
45      /***
46       * Tells if this step is a positioning step
47       * @return <code>true</code> if this step is a positioning step,
48       * <code>false</code> otherwise.
49       */
50      public boolean isPositioningStep();
51  
52      /***
53       * Tells if this step is an action
54       * @return <code>true</code> if this step is an action,
55       * <code>false</code> otherwise.
56       */
57      public boolean isAction();
58  
59      /***
60       * Tells if this step is a loop.
61       * @return <code>true</code> if this step is a loop,
62       * <code>false</code> otherwise.
63       */
64      public boolean isLoop();
65  
66  }