org.dspace.app.rest

Class RelationshipRestController

java.lang.Object

org.dspace.app.rest.RelationshipRestController

@RestController
 @RequestMapping(value="/api/core/relationships")
public class RelationshipRestController
extends Object

This will be the entry point for the api/core/relationships endpoint with additional paths to it

Constructor Summary

Constructors

Constructor and Description
RelationshipRestController()

Method Summary

Modifier and Type	Method and Description
RelationshipResourceWrapper	retrieveByLabel(javax.servlet.http.HttpServletResponse response, javax.servlet.http.HttpServletRequest request, String label, String dsoId, org.springframework.data.domain.Pageable pageable) This method will retrieve all the Relationships that have a RelationshipType which has a left or right label equal to the one passed along in the pathvariable.

Methods inherited from class java.lang.Object

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

Constructor Detail

RelationshipRestController

public RelationshipRestController()

Method Detail

retrieveByLabel

@RequestMapping(method=GET,
                value="/{label:^(?!^\\d+$)(?!^[0-9a-fxA-FX]{8}-[0-9a-fxA-FX]{4}-[0-9a-fxA-FX]{4}-[0-9a-fxA-FX]{4}-[0-9a-fxA-FX]{12}$)[\\w+\\-]+$+}")
public RelationshipResourceWrapper retrieveByLabel(javax.servlet.http.HttpServletResponse response,
                                                                                                                                                                                                                                      javax.servlet.http.HttpServletRequest request,
                                                                                                                                                                                                                                      @PathVariable
                                                                                                                                                                                                                                      String label,
                                                                                                                                                                                                                                      @RequestParam(name="dso",required=false)
                                                                                                                                                                                                                                      String dsoId,
                                                                                                                                                                                                                                      org.springframework.data.domain.Pageable pageable)
                                                                                                                                                                                                                               throws Exception

This method will retrieve all the Relationships that have a RelationshipType which has a left or right label equal to the one passed along in the pathvariable. This is further filtered by an optional dso parameter to filter on only the relationships for the given dso if this is applicable

Parameters:

response - The response object

request - The request object

label - The label on which the Relationship's RelationshipType will be matched

dsoId - The ID of the dso on which we'll search for relationships if applicable

pageable - The page object

Returns:

A Resource containing all the relationships that meet the criteria

Throws:

Exception - If something goes wrong