org.bibalex.daf.managers.checkin
Interface IRetrievalPlugin

All Known Implementing Classes:
DriveRetrieval, FolderRetrieval

public interface IRetrievalPlugin

The interface to be implemeneted in order to be recognized by the Retrieval plugin module.

Author:
Niveen.Nagy

Method Summary
 java.lang.String getPlugInName()
          Gets the name of the Plug-In.
 boolean initialize()
          This method initializes the interface
 boolean retrieveJob(Job job, int version, java.lang.String medBarcodeOrOnlineIP, BackupInfoDef backupInfo, RetrievalEventNotifier notifier)
          When implemented i a class it retrieves the job from the suitable media
 

Method Detail

getPlugInName

java.lang.String getPlugInName()
Gets the name of the Plug-In.

Returns:
The name of the Plug-In.

initialize

boolean initialize()
This method initializes the interface

Returns:
True if the initialize is performed correctly, false otherwise

retrieveJob

boolean retrieveJob(Job job,
                    int version,
                    java.lang.String medBarcodeOrOnlineIP,
                    BackupInfoDef backupInfo,
                    RetrievalEventNotifier notifier)
When implemented i a class it retrieves the job from the suitable media

Parameters:
job - The Job object to retrieve for.
version - The version to retrieve.
medBarcodeOrOnlineIP - The mediaBarcode in case of the drive retrieval or the online retrieval
backupInfo - The backupInfo, to know from the 'BackupAs' whether this is an old system or new system data retrieval.
notifier - This obfect is used to notify the observers for the GUI
Returns:
True if the retrieve sucsseeded otherwise false.