Package org.dspace.scripts.service

Interface ProcessService

All Known Implementing Classes:

ProcessServiceImpl

public interface ProcessService

An interface for the ProcessService with methods regarding the Process workload

Method Summary

Modifier and Type	Method	Description
void	complete(Context context, Process process)	This method will perform the logic needed to update the Process object in the database to represent a complete state
int	countTotal(Context context)	Returns the total amount of Process objects in the dataase
Process	create(Context context, EPerson ePerson, String scriptName, List<DSpaceCommandLineParameter> parameters)	This method will create a Process object in the database
void	delete(Context context, Process process)	This method will delete the given Process object from the database
void	fail(Context context, Process process)	This method will perform the logic needed to update the Process object in the database to represent a failed state
Process	find(Context context, int processId)	This method will retrieve a Process object from the Database with the given ID
List<Process>	findAll(Context context)	Returns a list of all Process objects in the database
List<Process>	findAll(Context context, int limit, int offset)	Returns a list of all Process objects in the database
List<Process>	findAllSortByScript(Context context)	Returns a list of all Process objects in the database sorted by script name
List<Process>	findAllSortByStartTime(Context context)	Returns a list of all Process objects in the database sorted by start time The most recent one will be shown first
List<DSpaceCommandLineParameter>	getParameters(Process process)	This method will retrieve the list of parameters from the Process in its String format and it will parse these parameters to a list of DSpaceCommandLineParameter objects for better usability throughout DSpace
void	start(Context context, Process process)	This method will perform the logic needed to update the Process object in the database to represent a started state.
void	update(Context context, Process process)	This method will be used to update the given Process object in the database

Method Detail

create

Process create(Context context,
               EPerson ePerson,
               String scriptName,
               List<DSpaceCommandLineParameter> parameters)
        throws SQLException

This method will create a Process object in the database

Parameters:

context - The relevant DSpace context

ePerson - The ePerson for which this process will be created on

scriptName - The script name to be used for the process

parameters - The parameters to be used for the process

Returns:

The created process

Throws:

SQLException - If something goes wrong

find

Process find(Context context,
             int processId)
      throws SQLException

This method will retrieve a Process object from the Database with the given ID

Parameters:

context - The relevant DSpace context

processId - The process id on which we'll search for in the database

Returns:

The process that holds the given process id

Throws:

SQLException - If something goes wrong

findAll

List<Process> findAll(Context context)
               throws SQLException

Returns a list of all Process objects in the database

Parameters:

context - The relevant DSpace context

Returns:

The list of all Process objects in the Database

Throws:

SQLException - If something goes wrong

findAll

List<Process> findAll(Context context,
                      int limit,
                      int offset)
               throws SQLException

Returns a list of all Process objects in the database

Parameters:

context - The relevant DSpace context

limit - The limit for the amount of Processes returned

offset - The offset for the Processes to be returned

Returns:

The list of all Process objects in the Database

Throws:

SQLException - If something goes wrong

findAllSortByScript

List<Process> findAllSortByScript(Context context)
                           throws SQLException

Returns a list of all Process objects in the database sorted by script name

Parameters:

context - The relevant DSpace context

Returns:

The list of all Process objects in the database sorted by script name

Throws:

SQLException - If something goes wrong

findAllSortByStartTime

List<Process> findAllSortByStartTime(Context context)
                              throws SQLException

Returns a list of all Process objects in the database sorted by start time The most recent one will be shown first

Parameters:

context - The relevant DSpace context

Returns:

The list of all Process objects sorted by start time

Throws:

SQLException - If something goes wrong

start

void start(Context context,
           Process process)
    throws SQLException

This method will perform the logic needed to update the Process object in the database to represent a started state. A started state refers to ProcessStatus.RUNNING

Parameters:

context - The relevant DSpace context

process - The Process object to be updated

Throws:

SQLException - If something goes wrong

fail

void fail(Context context,
          Process process)
   throws SQLException

This method will perform the logic needed to update the Process object in the database to represent a failed state

Parameters:

context - The relevant DSpace context

process - The Process object to be updated

Throws:

SQLException - If something goes wrong

complete

void complete(Context context,
              Process process)
       throws SQLException

This method will perform the logic needed to update the Process object in the database to represent a complete state

Parameters:

context - The relevant DSpace context

process - The Process object to be updated

Throws:

SQLException - If something goes wrong

delete

void delete(Context context,
            Process process)
     throws SQLException

This method will delete the given Process object from the database

Parameters:

context - The relevant DSpace context

process - The Process object to be deleted

Throws:

SQLException - If something goes wrong

update

void update(Context context,
            Process process)
     throws SQLException

This method will be used to update the given Process object in the database

Parameters:

context - The relevant DSpace context

process - The Process object to be updated

Throws:

SQLException - If something goes wrong

getParameters

List<DSpaceCommandLineParameter> getParameters(Process process)

This method will retrieve the list of parameters from the Process in its String format and it will parse these parameters to a list of DSpaceCommandLineParameter objects for better usability throughout DSpace

Parameters:

process - The Process object for which we'll return the parameters

Returns:

The list of parsed parameters from the Process object

countTotal

int countTotal(Context context)
        throws SQLException

Returns the total amount of Process objects in the dataase

Parameters:

context - The relevant DSpace context

Returns:

An integer that describes the amount of Process objects in the database

Throws:

SQLException - If something goes wrong