// $Header: /home/cvs/jakarta-jmeter/src/core/org/apache/jmeter/assertions/Assertion.java,v 1.3 2004/02/13 02:21:37 sebb Exp $
/*
 * Copyright 2001-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.jmeter.assertions;

import org.apache.jmeter.samplers.SampleResult;


/**
 * An Assertion checks a SampleResult to determine whether or not it is
 * successful.  The resulting success status can be obtained from a
 * corresponding Assertion Result.  For example, if a web response doesn't
 * contain an expected expression, it would be considered a failure.
 * 
 * @version $Revision: 1.3 $
 */
public interface Assertion
{
    /**
     * Returns the AssertionResult object encapsulating information about the
     * success or failure of the assertion.
     * 
     * @param response the SampleResult containing information about the
     *                 Sample (duration, success, etc)
     *
     * @return the AssertionResult containing the information about whether the
     *         assertion passed or failed.
     */
    AssertionResult getResult(SampleResult response);
}