/*******************************************************************************
 *
 * Copyright (c) 2004-2009 Oracle Corporation.
 *
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 * 
 *    Kohsuke Kawaguchi, Tom Huybrechts, Yahoo! Inc., InfraDNA, Inc.
 *
 *
 *******************************************************************************/ 

package hudson.tasks.junit;

import hudson.model.AbstractBuild;
import hudson.model.AbstractModelObject;
import hudson.model.Api;
import hudson.tasks.test.AbstractTestResultAction;
import org.kohsuke.stapler.export.ExportedBean;

import java.io.Serializable;
import java.util.List;

/**
 * Stub of base class for all test result objects. The real implementation of
 * the TestObject is in hudson.tasks.test.TestObject. This class simply defines
 * abstract methods so that legacy code will continue to compile.
 *
 * @deprecated Use {@link hudson.tasks.test.TestObject} instead.
 *
 * @author Kohsuke Kawaguchi
 */
@ExportedBean
public abstract class TestObject extends AbstractModelObject implements Serializable {

    public abstract AbstractBuild<?, ?> getOwner();

    public abstract TestObject getParent();

    public abstract String getId();

    /**
     * Returns url relative to TestResult
     */
    public abstract String getUrl();

    public abstract TestResult getTestResult();

    public abstract AbstractTestResultAction getTestResultAction();

    public abstract List<TestAction> getTestActions();

    public abstract <T> T getTestAction(Class<T> klazz);

    /**
     * Gets the counter part of this {@link TestObject} in the previous run.
     *
     * @return null if no such counter part exists.
     */
    public abstract TestObject getPreviousResult();

    public abstract TestObject getResultInBuild(AbstractBuild<?, ?> build);

    /**
     * Time took to run this test. In seconds.
     */
    public abstract float getDuration();

    /**
     * Returns the string representation of the {@link #getDuration()}, in a
     * human readable format.
     */
    public abstract String getDurationString();

    public abstract String getDescription();

    public abstract void setDescription(String description);

    /**
     * Exposes this object through the remote API.
     */
    public abstract Api getApi();

    /**
     * Gets the name of this object.
     */
    public abstract String getName();

    /**
     * Gets the version of {@link #getName()} that's URL-safe.
     */
    public abstract String getSafeName();

    public abstract String getSearchUrl();

    /**
     * Gets the total number of passed tests.
     */
    public abstract int getPassCount();

    /**
     * Gets the total number of failed tests.
     */
    public abstract int getFailCount();

    /**
     * Gets the total number of skipped tests.
     */
    public abstract int getSkipCount();

    /**
     * Gets the total number of tests.
     */
    public abstract int getTotalCount();

    public abstract History getHistory();
//    public abstract Object getDynamic(String token, StaplerRequest req,
//			StaplerResponse rsp);
//
//    public abstract  HttpResponse doSubmitDescription(
//			@QueryParameter String description) throws IOException,
//			ServletException;
}