za.co.interfile.easyscan.api
Class EasyScan

java.lang.Object
  extended by za.co.interfile.easyscan.api.EasyScan

public class EasyScan
extends java.lang.Object

Author:
Dylan Randall

Constructor Summary
EasyScan()
           
 
Method Summary
 java.util.ArrayList<java.lang.String> getExportDocumentTypes()
          Returns the available export document types from e@syScan
 java.util.ArrayList<java.lang.String> getImportDocumentTypes()
          Returns the available import document types from e@syScan
 java.lang.String getReleaseVersion()
          Returns the version of this e@syScan release
static void main(java.lang.String[] args)
           
 java.lang.String scanAndConvertToPDF(java.lang.String location, DocSettings settings, java.lang.String twainSource, java.lang.String metaDataDocumentType)
          API call for e@syFile integration - scan and convert to PDF
 java.lang.String scanAndConvertToPDF(java.lang.String location, java.lang.String twainSource, java.lang.String metadata)
          API call for e@syFile integration - scan and convert to PDF
 java.lang.String uploadAndConvertToPDF(java.lang.String fileLocation, java.lang.String destinationFile, java.lang.String metaData, java.lang.String fontsDirectory)
          API call for e@syFile integration - convert a file to PDF
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

EasyScan

public EasyScan()
Method Detail

getImportDocumentTypes

public java.util.ArrayList<java.lang.String> getImportDocumentTypes()
Returns the available import document types from e@syScan

Returns:
ArrayList

getExportDocumentTypes

public java.util.ArrayList<java.lang.String> getExportDocumentTypes()
Returns the available export document types from e@syScan

Returns:
ArrayList

getReleaseVersion

public java.lang.String getReleaseVersion()
Returns the version of this e@syScan release

Returns:
String

scanAndConvertToPDF

public java.lang.String scanAndConvertToPDF(java.lang.String location,
                                            java.lang.String twainSource,
                                            java.lang.String metadata)
                                     throws SK.gnome.twain.TwainException,
                                            java.io.IOException,
                                            java.lang.Exception
API call for e@syFile integration - scan and convert to PDF

Parameters:
location - - where to store converted file.
twainSource - - the source name of the scanner you wish to use
Returns:
path to the scanned and converted PDF.
Throws:
SK.gnome.twain.TwainException
java.io.IOException
java.lang.Exception

scanAndConvertToPDF

public java.lang.String scanAndConvertToPDF(java.lang.String location,
                                            DocSettings settings,
                                            java.lang.String twainSource,
                                            java.lang.String metaDataDocumentType)
                                     throws SK.gnome.twain.TwainException,
                                            java.io.IOException,
                                            java.lang.Exception
API call for e@syFile integration - scan and convert to PDF

Parameters:
location - - where to store converted file.
settings - - DocSettings class which contains settings for the scanner
twainSource - - the source name of the scanner you wish to use
metaDataDocumentType - - MetaData document tag
Returns:
Throws:
SK.gnome.twain.TwainException
java.io.IOException
java.lang.Exception

uploadAndConvertToPDF

public java.lang.String uploadAndConvertToPDF(java.lang.String fileLocation,
                                              java.lang.String destinationFile,
                                              java.lang.String metaData,
                                              java.lang.String fontsDirectory)
                                       throws java.io.FileNotFoundException,
                                              java.io.IOException,
                                              za.co.interfile.easyscan.exception.EasyScanException,
                                              java.lang.Exception
API call for e@syFile integration - convert a file to PDF

Parameters:
fileLocation - : Location of the input file that must be converted to PDF
destinationFile - : Location where the output file will be placed
metaData - : The metadata tag to be inserted into the PDF
Returns:
file location - if the conversion was successful
Throws:
java.io.FileNotFoundException
java.io.IOException
za.co.interfile.easyscan.exception.EasyScanException
java.lang.Exception

main

public static void main(java.lang.String[] args)
                 throws java.lang.Exception
Throws:
java.lang.Exception