Package org.dspace.discovery

Class IndexDiscoveryScriptConfiguration<T extends IndexClient>

java.lang.Object

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

org.dspace.discovery.IndexDiscoveryScriptConfiguration<T>

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware

public class IndexDiscoveryScriptConfiguration<T extends IndexClient>
extends ScriptConfiguration<T>

The ScriptConfiguration for the IndexClient script

Field Summary

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

options

Constructor Summary

Constructors

Constructor	Description
IndexDiscoveryScriptConfiguration()

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)	This method will return if the script is allowed to execute in the given context.
void	setDspaceRunnableClass(Class<T> dspaceRunnableClass)	Generic setter for the dspaceRunnableClass

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

getDescription, getName, setBeanName, setDescription, setName

Methods inherited from class java.lang.Object

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

Constructor Detail

IndexDiscoveryScriptConfiguration

public IndexDiscoveryScriptConfiguration()

Method Detail

getDspaceRunnableClass

public Class<T> getDspaceRunnableClass()

Description copied from class: ScriptConfiguration

Generic getter for the dspaceRunnableClass

Specified by:

getDspaceRunnableClass in class ScriptConfiguration<T extends IndexClient>

Returns:

the dspaceRunnableClass value of this ScriptConfiguration

isAllowedToExecute

public boolean isAllowedToExecute(Context context)

Description copied from class: ScriptConfiguration

This method will return if the script is allowed to execute in the given context. This is by default set to the currentUser in the context being an admin, however this can be overwritten by each script individually if different rules apply

Specified by:

isAllowedToExecute in class ScriptConfiguration<T extends IndexClient>

Parameters:

context - The relevant DSpace context

Returns:

A boolean indicating whether the script is allowed to execute or not

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 IndexClient>

Returns:

the options value of this ScriptConfiguration

setDspaceRunnableClass

public void setDspaceRunnableClass(Class<T> dspaceRunnableClass)

Generic setter for the dspaceRunnableClass

Specified by:

setDspaceRunnableClass in class ScriptConfiguration<T extends IndexClient>

Parameters:

dspaceRunnableClass - The dspaceRunnableClass to be set on this IndexDiscoveryScriptConfiguration