/******************************************************************************

  * NewPicScanner.java - Interface for jsp to run the NewPicScanner function

  * 

  * PicMan - The BuckoSoft Picture Manager in Java

  * Copyright(c) 2005 - Dick Balaska

  * 

  */

 package com.buckosoft.PicMan.business;

 import java.io.File;

 import java.util.ArrayList;

 import java.util.List;

 /** Interface for jsp to run the NewPicScanner process 

  * @author Dick Balaska

  * @since 2005/07/28

  * @version $Revision: 1.1 $ <br> $Date: 2013/12/26 01:26:07 $

  * @see <a href="http://cvs.buckosoft.com/Projects/java/PicMan/PicMan/src/com/buckosoft/PicMan/business/NewPicScanner.java">NewPicScanner.java</a>

  */

 public interface NewPicScanner {

         /** Set the list of file extensions that can be Pics.

          * @param picExtensions A List of extensions, without the period. "jpg", "png".  In the end, i am only running with "jpg" right now.

          */

         void        setPicExtensions(List<String> picExtensions);

         /** calling getNewPicCount() runs the scanner and returns the number of pics found.

          * @return The number of pics that exist under the {@link com.buckosoft.PicMan.domain.Root}s

          * that are not in the database.

          * @throws Exception

          */

         int                getNewPicCount() throws Exception;

         /** Get a list of the Files (Pics) found by running getNewPicCount()

          * @return The List of Files

          */

         ArrayList<File>        getNewPics();

         /** process any new pics that we've found.  Add them to the database, etc.

          * @return success

          */

         boolean processNewPics();

         /** If an error occurred during processNewPics, then it will be found here.

          * @return An error string

          */

         String        getProcessNewPicsErrorMessage();

 }