/*
    * $Header: /cvsroot/sinon/sinon/src/java/eteg/sinon/core/Action.java,v 1.2 2005/06/21 14:25:07 thiagohp Exp $
    * $Revision: 1.2 $
    * $Date: 2005/06/21 14:25:07 $
    * $Author: thiagohp $
    *
    * =============================================================================
    *
    * Copyright 2004-2005 Eteg Internet Ltda. (http://www.eteg.com.br)
   *
   * Licensed under the Apache License, Version 2.0 (the "License");
   * you may not use this file except in compliance with the License.
   * You may obtain a copy of the License at
   *
   *     http://www.apache.org/licenses/LICENSE-2.0
   *
   * Unless required by applicable law or agreed to in writing, software
   * distributed under the License is distributed on an "AS IS" BASIS,
   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   * See the License for the specific language governing permissions and
   * limitations under the License.
   */
  package eteg.sinon.core;
  
  /***
   * Class that represents an action to be executed after the data extraction
   * of a page.
   *
   * @author <a href="mailto:thiagohp at users.sourceforge.net">Thiago H. de Paula Figueiredo</a>
   * @author Last modified by $Author: thiagohp $
   * @version $Revision: 1.2 $
   */
  public class Action implements Step {
  
      /***
       * Processed page ID.
       */
      private String pageId;
  
      /***
       * Name of the list variable to be iterated. Optional attribute.
       */
      private String foreach;
  
      /***
       * Name of the variable that receives the value of the current list element.
       * Optional attribute.
       */
      private String variable;
  
      /***
       * Name of the variable that receives the current position in the iterated
       * list. Optional attribute.
       */
      private String index;
  
      /***
       * Condition that must be met in order the action to be executed.
       * Optional attribute.
       */
      private String condition;
  
      /***
       * Name of the property on which the condition will be tested.
       * Optional attribute.
       */
      private String propertyId;
  
      /***
       * URL of the page to be processed. Optional attribute.
       */
      private String url;
  
      /***
       * Configuration of the page to be processed. Optional attribute.
       */
      private PageConfiguration configuration;
  
      /***
       * Single constructor of this class.
       */
      public Action() {
      }
  
      /***
       * Returns the value of the property <code>pageId</code>.
       * @return a <code>String</code>.
       */
      public String getPageId() {
          return pageId;
      }
  
      /***
       * Sets the value of the <code>pageId</code> property.
       * @param pageId the new <code>pageId</code> value.
       */
      public void setPageId(String pageId) {
          this.pageId = pageId;
      }
 
     /***
      * Returns the value of the <code>foreach</code> property.
      * @return a <code>String</code>.
      */
     public String getForeach() {
         return foreach;
     }
 
     /***
      * Sets the value of the <code>foreach</code> property.
      * @param foreach the new <code>foreach</code> value.
      */
     public void setForeach(String foreach) {
         this.foreach = foreach;
     }
 
     /***
      * Returns the value of the <code>variable</code> property.
      * @return a <code>String</code>.
      */
     public String getVariable() {
         return variable;
     }
 
     /***
      * Sets the value of the <code>variable</code> property.
      * @param variable the new <code>variable</code> value.
      */
     public void setVariable(String variable) {
         this.variable = variable;
     }
 
     /***
      * Returns the value of the <code>index</code> property.
      * @return a <code>String</code>.
      */
     public String getIndex() {
         return index;
     }
 
     /***
      * Sets the value of the <code>index</code> property.
      * @param index the new <code>index</code> value.
      */
     public void setIndex(String index) {
         this.index = index;
     }
 
     /***
      * Returns the value of the <code>conditioni</code> property.
      * @return a <code>String</code>.
      */
     public String getCondition() {
         return condition;
     }
 
     /***
      * Sets the value of the <code>condition</code> property.
      * @param condition the new <code>condition</code> value.
      */
     public void setCondition(String condition) {
         this.condition = condition;
     }
 
     /***
      * Returns the value of the <code>propertyId</code> property.
      * @return a <code>String</code>.
      */
     public String getPropertyId() {
         return propertyId;
     }
 
     /***
      * Sets the value of the <code>propertyId</code> property.
      * @param propertyId the new <code>propertyId</code> value.
      */
     public void setPropertyId(String propertyId) {
         this.propertyId = propertyId;
     }
 
     /***
      * Returns the value of the <code>url</code> property.
      * @return a <code>String</code>.
      */
     public String getUrl() {
         return url;
     }
 
     /***
      * Sets the value of the <code>url</code> property.
      * @param url the new <code>url</code> value.
      */
     public void setUrl(String url) {
         this.url = url;
     }
 
     /***
      * Returns the value of the <code>configuration</code> property.
      * @return a <code>String</code>.
      */
     public PageConfiguration getConfiguration() {
         return configuration;
     }
 
     /***
      * Sets the value of the <code>configuration</code> property.
      * @param configuration the new <code>configuration</code> value.
      */
     public void setConfiguration(PageConfiguration configuration) {
         this.configuration = configuration;
     }
 
     /***
      * Returns <code>false</code>.
      */
     public boolean isDataExtraction() {
         return false;
     }
 
     /***
      * Returns <code>false</code>.
      */
     public boolean isPositioningStep() {
         return false;
     }
 
     /***
      * Returns <code>true</code>.
      */
     public boolean isAction() {
         return true;
     }
 
     /***
      * Returns <code>false</code>.
      */
     public boolean isLoop() {
         return false;
     }
 
 }