Package org.dspace.app.rest

Class WorkflowDefinitionCollectionsLinkRepository

java.lang.Object

org.dspace.app.rest.repository.AbstractDSpaceRestRepository

org.dspace.app.rest.WorkflowDefinitionCollectionsLinkRepository

All Implemented Interfaces:

LinkRestRepository

@Component("config.workflowdefinitions.collections")
public class WorkflowDefinitionCollectionsLinkRepository
extends AbstractDSpaceRestRepository
implements LinkRestRepository

Link repository for "collections" subresource of an individual workflow definition.

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
WorkflowDefinitionCollectionsLinkRepository()

Method Summary

Modifier and Type	Method	Description
org.springframework.data.domain.Page<CollectionRest>	getCollections(jakarta.servlet.http.HttpServletRequest request, String workflowName, org.springframework.data.domain.Pageable optionalPageable, Projection projection)	GET endpoint that returns the list of collections that make an explicit use of the workflow-definition.

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

Methods inherited from interface org.dspace.app.rest.repository.LinkRestRepository

isEmbeddableRelation

Field Details

xmlWorkflowFactory

@Autowired
protected XmlWorkflowFactory xmlWorkflowFactory

Constructor Details

WorkflowDefinitionCollectionsLinkRepository

public WorkflowDefinitionCollectionsLinkRepository()

Method Details

getCollections

@PreAuthorize("hasAuthority(\'AUTHENTICATED\')")
public org.springframework.data.domain.Page<CollectionRest> getCollections(@Nullable
 jakarta.servlet.http.HttpServletRequest request,
 String workflowName,
 @Nullable
 org.springframework.data.domain.Pageable optionalPageable,
 Projection projection)

GET endpoint that returns the list of collections that make an explicit use of the workflow-definition. If a collection doesn't specify the workflow-definition to be used, the default mapping applies, but this collection is not included in the list returned by this method.

Parameters:

request - The request object

workflowName - Name of workflow we want the collections of that are mapped to is

Returns:

List of collections mapped to the requested workflow