wamblee.org Git - utils/blob - crawler/basic/src/org/wamblee/crawler/Action.java

   1 /*
   2  * Copyright 2005 the original author or authors.
   3  *
   4  * Licensed under the Apache 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.apache.org/licenses/LICENSE-2.0
   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
  17 package org.wamblee.crawler;
  18
  19 import org.apache.commons.httpclient.NameValuePair;
  20 import org.dom4j.Element;
  21
  22 /**
  23  * An action defined on a page.
  24  */
  25 public interface Action {
  26
  27     /**
  28      * The name of the action.
  29      * @return Action name.
  30      */
  31     String getName();
  32
  33     /**
  34      * Executes the action.
  35      * @return New page as a result of the action.
  36      * @throws PageException In case of an error obtaining the page.
  37      */
  38     Page execute() throws PageException;
  39
  40     /**
  41      * Gets a description of the action. THe element returned is the action element
  42      * itself.
  43      * @return Content as XML.
  44      */
  45     Element getContent();
  46 }