/*

 ============================================================================
                   The Apache Software License, Version 1.1
 ============================================================================

 Copyright (C) @year@ The Apache Software Foundation. All rights reserved.

 Redistribution and use in source and binary forms, with or without modifica-
 tion, are permitted provided that the following conditions are met:

 1. Redistributions of  source code must  retain the above copyright  notice,
    this list of conditions and the following disclaimer.

 2. Redistributions in binary form must reproduce the above copyright notice,
    this list of conditions and the following disclaimer in the documentation
    and/or other materials provided with the distribution.

 3. The end-user documentation included with the redistribution, if any, must
    include  the following  acknowledgment:  "This product includes  software
    developed  by the  Apache Software Foundation  (http://www.apache.org/)."
    Alternately, this  acknowledgment may  appear in the software itself,  if
    and wherever such third-party acknowledgments normally appear.

 4. The names "Jakarta", "Avalon", "Excalibur" and "Apache Software Foundation"
    must not be used to endorse or promote products derived from this  software
    without  prior written permission. For written permission, please contact
    apache@apache.org.

 5. Products  derived from this software may not  be called "Apache", nor may
    "Apache" appear  in their name,  without prior written permission  of the
    Apache Software Foundation.

 THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
 INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 FITNESS  FOR A PARTICULAR  PURPOSE ARE  DISCLAIMED.  IN NO  EVENT SHALL  THE
 APACHE SOFTWARE  FOUNDATION  OR ITS CONTRIBUTORS  BE LIABLE FOR  ANY DIRECT,
 INDIRECT, INCIDENTAL, SPECIAL,  EXEMPLARY, OR CONSEQUENTIAL  DAMAGES (INCLU-
 DING, BUT NOT LIMITED TO, PROCUREMENT  OF SUBSTITUTE GOODS OR SERVICES; LOSS
 OF USE, DATA, OR  PROFITS; OR BUSINESS  INTERRUPTION)  HOWEVER CAUSED AND ON
 ANY  THEORY OF LIABILITY,  WHETHER  IN CONTRACT,  STRICT LIABILITY,  OR TORT
 (INCLUDING  NEGLIGENCE OR  OTHERWISE) ARISING IN  ANY WAY OUT OF THE  USE OF
 THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

 This software  consists of voluntary contributions made  by many individuals
 on  behalf of the Apache Software  Foundation. For more  information on the
 Apache Software Foundation, please see <http://www.apache.org/>.

*/
package org.apache.infomover.jobmanager;

import java.util.List;

/**
 * The <code>JobDescriptor</code> interface represents a job that is in the queue.
 *
 * @author <a href="mailto:bloritsch@apache.org">Berin Loritsch</a>
 * @version 1.0
 */
public final class JobDescriptor
{
    private final String m_name;
    private final long   m_lastRun;
    private final long   m_nextRun;
    private final int    m_lastTransactionCount;
    private final int    m_lastSuccessfulTransactionCount;
    private final List   m_dependencies;

    public JobDescriptor(String name, Job job, long nextRun, List dependencies)
    {
        m_name = name;
        m_lastRun = job.getLastRun();
        m_nextRun = nextRun;
        m_lastTransactionCount = job.lastTransactionCount();
        m_lastSuccessfulTransactionCount = job.lastSuccessfulTransactionCount();
        m_dependencies = dependencies;
    }

    /**
     * Get's the Job name
     */
    public String getName()
    {
        return m_name;
    }

    /**
     * Returns the time when the job was last executed.  It helps in checking
     * if the job is current.
     */
    public long getLastRun()
    {
        return m_lastRun;
    }

    /**
     * Returns the next time when the job will be executed.
     */
    public long getNextRun()
    {
        return m_nextRun;
    }

    /**
     * Get the number of transactions processed in the last run
     */
    public int getLastTransactionCount()
    {
        return m_lastTransactionCount;
    }

    /**
     * Get the number of transactions successfully processed in the last run
     */
    public int getLastSuccessfulTransactionCount()
    {
        return m_lastSuccessfulTransactionCount;
    }

    /**
     * Returns the list of jobs that this one depends on.
     */
    public String[] getDependencies()
    {
        String[] dependencies = new String[m_dependencies.size()];
        m_dependencies.toArray(dependencies);
        return dependencies;
    }
}