org.dspace.app.xmlui.aspect.administrative

Class FlowCurationUtils

java.lang.Object

org.dspace.app.xmlui.aspect.administrative.FlowCurationUtils

public class FlowCurationUtils
extends java.lang.Object

Author:

wbossons

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.Map<java.lang.String,java.lang.String>	allTasks
static java.lang.String	CURATE_GROUP_NAMES
static java.lang.String	CURATE_GROUP_PREFIX
static java.lang.String	CURATE_TASK_NAMES Utility methods to support curation groups/tasks form fields
static java.util.Map<java.lang.String,java.lang.String[]>	groupedTasks
static java.util.Map<java.lang.String,java.lang.String>	groups
static java.lang.String	UNGROUPED_TASKS

Constructor Summary

Constructors

Constructor and Description
FlowCurationUtils()

Method Summary

Methods

Modifier and Type	Method and Description
protected static Curator	getCurator(java.lang.String taskName)
static Select	getGroupSelectOptions(Select select)
protected static FlowResult	getQueueFlowResult(java.lang.String taskName, boolean status, java.lang.String objId, java.lang.String queueName) Build a FlowResult which will provide a Notice to users, notifying them of whether the Curation task was queued successfully or not
protected static FlowResult	getRunFlowResult(java.lang.String taskName, Curator curator, boolean success) Build a FlowResult which will provide a Notice to users, notifying them of whether the Curation task succeeded or failed.
static Select	getTaskSelectOptions(Select select, java.lang.String curateGroup)
protected static java.lang.String	getUITaskName(java.lang.String taskID) Retrieve UI "friendly" Task Name for display to user
static FlowResult	processCurateObject(Context context, org.apache.cocoon.environment.Request request) Utility method to process curation tasks submitted via the DSpace Admin UI Curate Form.
static FlowResult	processQueueObject(Context context, org.apache.cocoon.environment.Request request) Utility method to queue curation tasks submitted via the DSpace Admin UI Curate Form.
static void	setAllTasks()
static void	setGroupedTasks()
static void	setGroups()
static void	setupCurationTasks()

Methods inherited from class java.lang.Object

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

Field Detail

CURATE_TASK_NAMES

public static final java.lang.String CURATE_TASK_NAMES

Utility methods to support curation groups/tasks form fields

See Also:

Constant Field Values

CURATE_GROUP_NAMES

public static final java.lang.String CURATE_GROUP_NAMES

See Also:

Constant Field Values

CURATE_GROUP_PREFIX

public static final java.lang.String CURATE_GROUP_PREFIX

See Also:

Constant Field Values

UNGROUPED_TASKS

public static final java.lang.String UNGROUPED_TASKS

See Also:

Constant Field Values

allTasks

public static java.util.Map<java.lang.String,java.lang.String> allTasks

groupedTasks

public static java.util.Map<java.lang.String,java.lang.String[]> groupedTasks

groups

public static java.util.Map<java.lang.String,java.lang.String> groups

Constructor Detail

FlowCurationUtils

public FlowCurationUtils()

Method Detail

getCurator

protected static Curator getCurator(java.lang.String taskName)

getRunFlowResult

protected static FlowResult getRunFlowResult(java.lang.String taskName,
                          Curator curator,
                          boolean success)

Build a FlowResult which will provide a Notice to users, notifying them of whether the Curation task succeeded or failed.

Parameters:

taskName - name of Curation Task

curator - active Curator

success - whether it succeeded or failed

Returns:

FlowResult

getQueueFlowResult

protected static FlowResult getQueueFlowResult(java.lang.String taskName,
                            boolean status,
                            java.lang.String objId,
                            java.lang.String queueName)

Build a FlowResult which will provide a Notice to users, notifying them of whether the Curation task was queued successfully or not

Parameters:

taskName - name of Curation Task

status - whether it succeeded or failed

objId - the DSpace object ID

queueName - the name of the queue

Returns:

FlowResult

getUITaskName

protected static java.lang.String getUITaskName(java.lang.String taskID)

Retrieve UI "friendly" Task Name for display to user

Parameters:

taskID - the short name / identifier for the task

Returns:

the User Friendly name for this task

processCurateObject

public static FlowResult processCurateObject(Context context,
                             org.apache.cocoon.environment.Request request)

Utility method to process curation tasks submitted via the DSpace Admin UI Curate Form.

Parameters:

context - current DSpace Context

request - current Cocoon request

Returns:

FlowResult representing the result of request

See Also:

CurateForm

processQueueObject

public static FlowResult processQueueObject(Context context,
                            org.apache.cocoon.environment.Request request)

Utility method to queue curation tasks submitted via the DSpace Admin UI Curate Form.

Parameters:

context - current DSpace Context

request - current Cocoon request

Returns:

FlowResult representing the result of request

See Also:

CurateForm

setupCurationTasks

public static void setupCurationTasks()

setAllTasks

public static void setAllTasks()
                        throws WingException,
                               java.io.UnsupportedEncodingException

Throws:

WingException

java.io.UnsupportedEncodingException

setGroups

public static void setGroups()
                      throws WingException,
                             java.io.UnsupportedEncodingException

Throws:

WingException

java.io.UnsupportedEncodingException

setGroupedTasks

public static void setGroupedTasks()
                            throws WingException,
                                   java.io.UnsupportedEncodingException

Throws:

WingException

java.io.UnsupportedEncodingException

getGroupSelectOptions

public static Select getGroupSelectOptions(Select select)
                                    throws WingException

Throws:

WingException

getTaskSelectOptions

public static Select getTaskSelectOptions(Select select,
                          java.lang.String curateGroup)
                                   throws WingException

Throws:

WingException