[Batchserver-cvs] batchserver/src/org/jmonks/batchserver/framework/controller/pool AbstractPoolJobLoader.java,1.4,1.5

[Suresh <sur...@us...>]

Update of /cvsroot/batchserver/batchserver/src/org/jmonks/batchserver/framework/controller/pool
In directory sc8-pr-cvs3.sourceforge.net:/tmp/cvs-serv29696

Added Files:
	AbstractPoolJobLoader.java 
Log Message:
no message

--- NEW FILE: AbstractPoolJobLoader.java ---
/*
 * AbstractPoolJobLoader.java
 *
 * Created on May 16, 2006, 4:49 PM
 *
 * To change this template, choose Tools | Options and locate the template under
 * the Source Creation and Management node. Right-click the template and choose
 * Open. You can then make changes to the template in the Source Editor.
 */

package org.jmonks.batchserver.framework.controller.pool;

import java.util.Map;
import org.jmonks.batchserver.framework.management.ProcessorStatus;

/**
 *  <p>
 *  AbstractPoolJobLoader implements all the management and monitoring methods
 *  and abstracts the user from the job pool. This allows the loader implementation
 *  to concentrate on the business logic.
 *  </p>
 *
 *  @author     Suresh Pragada
 *  @version    1.0
 *  @since      1.0
 */
public abstract class AbstractPoolJobLoader implements PoolJobLoader
{
    /**
     *  Holds the status of the loader.
     */
    protected ProcessorStatus loaderStatus=ProcessorStatus.INITIALIZING;
        
    /**
     *  Returns the processing state of the loader. 
     *
     *  @return Returns the job data that this loader is loading.
     */
    public Object getLoaderState()
    {
        return null;
    }
    
    /**
     *  Returns the status of the loader.
     *
     *  @return Returns the status of the loader.
     */
    public ProcessorStatus getLoaderStatus()
    {
        return this.loaderStatus;
    }


    public ErrorCode loadPool(JobPool pool)
    {
        return null;
    }
    
    public abstract 

    public boolean resume()
    {
        return true;
    }

    public boolean stop()
    {
        return true;
    }

    public boolean suspend()
    {
        return true;
    }

    /**
     *  Chance to grab the properties defined for this job loader in job 
     *  configuration and do some initialization.
     *
     *  @param  configProps Properties defined in job configuration as a Map.
     */
    public abstract void initialize(Map configProps);
    
    /**
     *  Chance to do some cleanup for the Loader implementation.
     */
    public abstract void cleanup();
    
    /**
     *  Returns the number of job data objects that this loader is going to load.
     *
     *  @return Return the number of job data object its going to load.
     */
    public abstract int getTotalJobDataCount();    
}