Package org.dspace.app.rest.submit.step

Class DescribeStep

java.lang.Object

org.dspace.app.rest.submit.AbstractProcessingStep

org.dspace.app.rest.submit.step.DescribeStep

All Implemented Interfaces:

DataProcessingStep, RestProcessingStep

public class DescribeStep
extends AbstractProcessingStep

Describe step for DSpace Spring Rest. Expose and allow patching of the in progress submission metadata. It is configured via the config/submission-forms.xml file

Author:

Luigi Andrea Pascarelli (luigiandrea.pascarelli at 4science.it), Andrea Bollini (andrea.bollini at 4science.it)

Field Summary

Fields inherited from class org.dspace.app.rest.submit.AbstractProcessingStep

authorizeService, bitstreamFormatService, bitstreamService, bundleService, collectionService, configurationService, itemService, metadataFieldService, workspaceItemService

Fields inherited from interface org.dspace.app.rest.submit.DataProcessingStep

CCLICENSE_STEP_OPERATION_ENTRY, COLLECTION_STEP_OPERATION_ENTRY, DESCRIBE_STEP_METADATA_OPERATION_ENTRY, LICENSE_STEP_OPERATION_ENTRY, UPLOAD_STEP_ACCESSCONDITIONS_OPERATION_ENTRY, UPLOAD_STEP_METADATA_OPERATION_ENTRY, UPLOAD_STEP_METADATA_PATH, UPLOAD_STEP_MOVE_OPERATION_ENTRY, UPLOAD_STEP_REMOVE_OPERATION_ENTRY

Constructor Summary

Constructors

Constructor	Description
DescribeStep()

Method Summary

Modifier and Type	Method	Description
void	doPatchProcessing(org.dspace.core.Context context, javax.servlet.http.HttpServletRequest currentRequest, org.dspace.content.InProgressSubmission source, Operation op, org.dspace.app.util.SubmissionStepConfig stepConf)	Method to react to a patch request against the step managed section data
DataDescribe	getData(SubmissionService submissionService, org.dspace.content.InProgressSubmission obj, org.dspace.app.util.SubmissionStepConfig config)	Method to expose data in the a dedicated section of the in progress submission.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.dspace.app.rest.submit.DataProcessingStep

validate

Constructor Detail

DescribeStep

public DescribeStep()
             throws org.dspace.app.util.DCInputsReaderException

Throws:

org.dspace.app.util.DCInputsReaderException

Method Detail

getData

public DataDescribe getData(SubmissionService submissionService,
                            org.dspace.content.InProgressSubmission obj,
                            org.dspace.app.util.SubmissionStepConfig config)

Description copied from interface: DataProcessingStep

Method to expose data in the a dedicated section of the in progress submission. The step needs to return a serializable object that will be included in a section with the name (id) assigned to the step in the item-submission.xml file

Parameters:

submissionService - the submission service

obj - the in progress submission

config - the submission step configuration

Returns:

the serializable object to include in the step generated section

doPatchProcessing

public void doPatchProcessing(org.dspace.core.Context context,
                              javax.servlet.http.HttpServletRequest currentRequest,
                              org.dspace.content.InProgressSubmission source,
                              Operation op,
                              org.dspace.app.util.SubmissionStepConfig stepConf)
                       throws Exception

Description copied from interface: DataProcessingStep

Method to react to a patch request against the step managed section data

Parameters:

context - the DSpace context

currentRequest - the http request

source - the in progress submission

op - the json patch operation

Throws:

Exception