Package org.dspace.curate

Class CurationScriptConfiguration<T extends Curation>

java.lang.Object

org.dspace.scripts.configuration.ScriptConfiguration<T>

org.dspace.curate.CurationScriptConfiguration<T>

All Implemented Interfaces:

Aware, BeanNameAware

Direct Known Subclasses:

CurationCliScriptConfiguration

public class CurationScriptConfiguration<T extends Curation>
extends ScriptConfiguration<T>

The ScriptConfiguration for the Curation script

Author:

Maria Verdonck (Atmire) on 23/06/2020

Field Summary

Fields inherited from class org.dspace.scripts.configuration.ScriptConfiguration

authorizeService, options

Constructor Summary

Constructors

Constructor	Description
CurationScriptConfiguration()

Method Summary

Modifier and Type	Method	Description
Class<T>	getDspaceRunnableClass()	Generic getter for the dspaceRunnableClass
org.apache.commons.cli.Options	getOptions()	The getter for the options of the Script
boolean	isAllowedToExecute(Context context, List<DSpaceCommandLineParameter> commandLineParameters)	Only repository admins or admins of the target object can run Curation script via the scripts and processes endpoints.
void	setDspaceRunnableClass(Class<T> dspaceRunnableClass)	Generic setter for the dspaceRunnableClass

Methods inherited from class org.dspace.scripts.configuration.ScriptConfiguration

getDescription, getHelpOptions, getName, setBeanName, setDescription, setName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

CurationScriptConfiguration

public CurationScriptConfiguration()

Method Details

getDspaceRunnableClass

public Class<T> getDspaceRunnableClass()

Description copied from class: ScriptConfiguration

Generic getter for the dspaceRunnableClass

Specified by:

getDspaceRunnableClass in class ScriptConfiguration<T extends Curation>

Returns:

the dspaceRunnableClass value of this ScriptConfiguration

setDspaceRunnableClass

public void setDspaceRunnableClass(Class<T> dspaceRunnableClass)

Description copied from class: ScriptConfiguration

Generic setter for the dspaceRunnableClass

Specified by:

setDspaceRunnableClass in class ScriptConfiguration<T extends Curation>

Parameters:

dspaceRunnableClass - The dspaceRunnableClass to be set on this IndexDiscoveryScriptConfiguration

isAllowedToExecute

public boolean isAllowedToExecute(Context context,
 List<DSpaceCommandLineParameter> commandLineParameters)

Only repository admins or admins of the target object can run Curation script via the scripts and processes endpoints.

Overrides:

isAllowedToExecute in class ScriptConfiguration<T extends Curation>

Parameters:

context - The relevant DSpace context

commandLineParameters - the parameters that will be used to start the process if known, null otherwise

Returns:

true if the currentUser is allowed to run the script with the specified parameters or at least in some case if the parameters are not yet known

getOptions

public org.apache.commons.cli.Options getOptions()

Description copied from class: ScriptConfiguration

The getter for the options of the Script

Specified by:

getOptions in class ScriptConfiguration<T extends Curation>

Returns:

the options value of this ScriptConfiguration