org.dspace.curate

Interface ScriptedTask

public interface ScriptedTask

ScriptedTask describes a rather generic ability to perform an operation upon a DSpace object. It's semantics are identical to the CurationTask interface, but is designed to be implemented in scripting languages, rather than Java. For this reason, the 'perform' methods are renamed to accomodate languages (like Ruby) that lack method overloading.

Author:

richardrodgers

Method Summary

Methods

Modifier and Type	Method and Description
void	init(Curator curator, java.lang.String taskId) Initialize task - parameters inform the task of it's invoking curator.
int	performDso(DSpaceObject dso) Perform the curation task upon passed DSO
int	performId(Context ctx, java.lang.String id) Perform the curation task for passed id

Method Detail

init

void init(Curator curator,
        java.lang.String taskId)
          throws java.io.IOException

Initialize task - parameters inform the task of it's invoking curator. Since the curator can provide services to the task, this represents curation DI.

Parameters:

curator - the Curator controlling this task

taskId - identifier task should use in invoking services

Throws:

java.io.IOException

performDso

int performDso(DSpaceObject dso)
               throws java.io.IOException

Perform the curation task upon passed DSO

Parameters:

dso - the DSpace object

Returns:

status code

Throws:

java.io.IOException

performId

int performId(Context ctx,
            java.lang.String id)
              throws java.io.IOException

Perform the curation task for passed id

Parameters:

ctx - DSpace context object

id - persistent ID for DSpace object

Returns:

status code

Throws:

java.io.IOException