/*

  * Copyright 1999-2002,2004 The Apache Software Foundation.

  * 

  * 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.apache.commons.latka.event;

 import java.util.List;

 import org.apache.commons.latka.http.Request;

 import org.apache.commons.latka.http.Session;

 /**

  * An extension to LatkaEventListener that stores the success or

  * failure of all requests.  

  * All of these events should report true by default.  They

  * should only report false once an unsuccessful request

  * is reported to the listener.

  *

  * @author Morgan Delagrange

  * @version $Id: LatkaEventInfo.java 155424 2005-02-26 13:09:29Z dirkv $

  */

 public interface LatkaEventInfo extends LatkaEventListener {

   /**

    * Check to see if a particular Request succeeded or failed.

    *

    * @param request the request to check for success or

    * failure

    * @return true if request succeeded

    */

   boolean didRequestSucceed(Request request);

   /**

    * Check to see if a particular Session succeeded or failed.

    * Once a request inside a session fails, the session itself

    * is marked as a failure.

    *

    * @param session the session to check for success or

    * failure

    * @return true if all requests in the session succeeded

    */

   boolean didSessionSucceed(Session session);

   /**

    * Returns true if all Requests in the suite succeed.

    *

    * @return true if all Requests have succeeded

    */

   boolean didSuiteSucceed();

   /**

    * Returns a List of all responses that failed

    * validation.

    *

    * @return List of failed Responses

    */

   List getFailedResponses();

 }