/*
 * Copyright 2005 the original author or authors.
 * 
 * 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 org.wamblee.crawler;

import org.apache.commons.httpclient.NameValuePair;
import org.dom4j.Element;

/**
 * An action defined on a page. 
 */
public interface Action {
    
    /**
     * The name of the action. 
     * @return Action name. 
     */
    String getName(); 
    
    /**
     * Executes the action. 
     * @return New page as a result of the action.
     * @throws PageException In case of an error obtaining the page. 
     */
    Page execute() throws PageException;
    
    /**
     * Gets a description of the action. THe element returned is the action element
     * itself. 
     * @return Content as XML.
     */
    Element getContent();
}