Package org.dspace.app.rest.repository

Class WorkflowDefinitionRestRepository

java.lang.Object

org.dspace.app.rest.repository.AbstractDSpaceRestRepository

org.dspace.app.rest.repository.DSpaceRestRepository<WorkflowDefinitionRest,String>

org.dspace.app.rest.repository.WorkflowDefinitionRestRepository

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, org.springframework.data.repository.CrudRepository<WorkflowDefinitionRest,String>, org.springframework.data.repository.PagingAndSortingRepository<WorkflowDefinitionRest,String>, org.springframework.data.repository.Repository<WorkflowDefinitionRest,String>

@Component("config.workflowdefinition")
public class WorkflowDefinitionRestRepository
extends DSpaceRestRepository<WorkflowDefinitionRest,String>

This is the rest repository responsible for managing WorkflowDefinition Rest objects

Author:

Maria Verdonck (Atmire) on 11/12/2019

Field Summary

Fields

Modifier and Type	Field	Description
protected XmlWorkflowFactory	xmlWorkflowFactory

Fields inherited from class org.dspace.app.rest.repository.AbstractDSpaceRestRepository

converter, requestService, utils

Constructor Summary

Constructors

Constructor	Description
WorkflowDefinitionRestRepository()

Method Summary

Modifier and Type	Method	Description
org.springframework.data.domain.Page<WorkflowDefinitionRest>	findAll(Context context, org.springframework.data.domain.Pageable pageable)	Method to implement to support scroll of entity instances from the collection resource endpoint
WorkflowDefinitionRest	findByCollection(UUID collectionId)	GET endpoint that returns the workflow definition that applies to a specific collection eventually fallback to the default configuration.
WorkflowDefinitionRest	findOne(Context context, String workflowName)	Method to implement to support retrieval of a specific REST object instance
Class<WorkflowDefinitionRest>	getDomainClass()	The REST model supported by the repository

Methods inherited from class org.dspace.app.rest.repository.DSpaceRestRepository

action, action, count, createAndReturn, createAndReturn, createAndReturn, createAndReturn, createAndReturn, createAndReturn, delete, delete, deleteAll, deleteAll, deleteAllById, deleteById, existsById, findAll, findAll, findAll, findAllById, findById, patch, patch, put, put, put, put, save, save, saveAll, setBeanName, upload, upload, upload

Methods inherited from class org.dspace.app.rest.repository.AbstractDSpaceRestRepository

getRequestService, obtainContext

Methods inherited from class java.lang.Object

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

Field Detail

xmlWorkflowFactory

@Autowired
protected XmlWorkflowFactory xmlWorkflowFactory

Constructor Detail

WorkflowDefinitionRestRepository

public WorkflowDefinitionRestRepository()

Method Detail

findOne

@PreAuthorize("hasAuthority(\'AUTHENTICATED\')")
public WorkflowDefinitionRest findOne(Context context,
                                      String workflowName)

Description copied from class: DSpaceRestRepository

Method to implement to support retrieval of a specific REST object instance

Specified by:

findOne in class DSpaceRestRepository<WorkflowDefinitionRest,String>

Parameters:

context - the dspace context

workflowName - the rest object id

Returns:

the REST object identified by its ID

findAll

@PreAuthorize("hasAuthority(\'AUTHENTICATED\')")
public org.springframework.data.domain.Page<WorkflowDefinitionRest> findAll(Context context,
                                                                            org.springframework.data.domain.Pageable pageable)

Description copied from class: DSpaceRestRepository

Method to implement to support scroll of entity instances from the collection resource endpoint

Specified by:

findAll in class DSpaceRestRepository<WorkflowDefinitionRest,String>

Parameters:

context - the dspace context

pageable - object embedding the requested pagination info

Returns:

findByCollection

@PreAuthorize("hasAuthority(\'AUTHENTICATED\')")
public WorkflowDefinitionRest findByCollection(UUID collectionId)
                                        throws SQLException

GET endpoint that returns the workflow definition that applies to a specific collection eventually fallback to the default configuration.

Parameters:

collectionId - Uuid of the collection

Returns:

the workflow definition for this collection

Throws:

SQLException

getDomainClass

public Class<WorkflowDefinitionRest> getDomainClass()

Description copied from class: DSpaceRestRepository

The REST model supported by the repository

Specified by:

getDomainClass in class DSpaceRestRepository<WorkflowDefinitionRest,String>