java.lang.Object
- org.dspace.app.rest.repository.AbstractDSpaceRestRepository
- - org.dspace.app.rest.repository.DSpaceRestRepository<WorkspaceItemRest,Integer>
  - - org.dspace.app.rest.repository.WorkspaceItemRestRepository

All Implemented Interfaces:

ReloadableEntityObjectRepository<WorkspaceItem,Integer>, org.springframework.data.repository.CrudRepository<WorkspaceItemRest,Integer>, org.springframework.data.repository.PagingAndSortingRepository<WorkspaceItemRest,Integer>, org.springframework.data.repository.Repository<WorkspaceItemRest,Integer>
```
@Component("submission.workspaceitem")
public class WorkspaceItemRestRepository
extends DSpaceRestRepository<WorkspaceItemRest,Integer>
implements ReloadableEntityObjectRepository<WorkspaceItem,Integer>
```
This is the repository responsible to manage WorkspaceItem Rest object

Author:

Andrea Bollini (andrea.bollini at 4science.it), Pasquale Cavallo (pasquale.cavallo at 4science.it)

Field Summary

Fields
Modifier and Type Field Description

static String OPERATION_PATH_SECTIONS
- Fields inherited from class org.dspace.app.rest.repository.AbstractDSpaceRestRepository
  converter, requestService, utils

Constructor Summary

Constructors
Constructor Description

WorkspaceItemRestRepository()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected WorkspaceItemRest`	`createAndReturn(Context context)`	Method to implement to support the creation of a new instance.
`protected WorkspaceItemRest`	`createAndReturn(Context context, List<String> stringList)`	Method to implement to support the creation of a new instance.
`protected void`	`delete(Context context, Integer id)`	Method to implement to support delete of a single object instance
`org.springframework.data.domain.Page<WorkspaceItemRest>`	`findAll(Context context, org.springframework.data.domain.Pageable pageable)`	Method to implement to support scroll of entity instances from the collection resource endpoint
`WorkspaceItemRest`	`findByItemUuid(UUID itemUuid, org.springframework.data.domain.Pageable pageable)`	This is a search method that will return the WorkspaceItemRest object found through the UUID of an item.
`org.springframework.data.domain.Page<WorkspaceItemRest>`	`findBySubmitter(UUID submitterID, org.springframework.data.domain.Pageable pageable)`
`WorkspaceItem`	`findDomainObjectByPk(Context context, Integer id)`
`WorkspaceItemRest`	`findOne(Context context, Integer id)`	Method to implement to support retrieval of a specific REST object instance
`Class<WorkspaceItemRest>`	`getDomainClass()`	The REST model supported by the repository
`Class<Integer>`	`getPKClass()`
`void`	`patch(Context context, javax.servlet.http.HttpServletRequest request, String apiCategory, String model, Integer id, Patch patch)`	Method to implement to allow partial update of the REST object via JSON Patch
`WorkspaceItemRest`	`upload(javax.servlet.http.HttpServletRequest request, String apiCategory, String model, Integer id, org.springframework.web.multipart.MultipartFile file)`	Method to implement to attach/upload a file to a specific REST object
`Iterable<WorkspaceItemRest>`	`upload(Context context, javax.servlet.http.HttpServletRequest request, List<org.springframework.web.multipart.MultipartFile> uploadfiles)`	Method to implement to support bulk creation of objects from a file

Methods inherited from class org.dspace.app.rest.repository.DSpaceRestRepository
action, action, count, createAndReturn, createAndReturn, createAndReturn, createAndReturn, delete, deleteAll, deleteAll, deleteById, existsById, findAll, findAll, findAll, findAllById, findById, patch, put, put, put, put, save, save, saveAll, 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
  - OPERATION_PATH_SECTIONS
```
public static final String OPERATION_PATH_SECTIONS
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - WorkspaceItemRestRepository
```
public WorkspaceItemRestRepository()
                            throws SubmissionConfigReaderException
```
    Throws:
    
    SubmissionConfigReaderException
- Method Detail
  - findOne
```
@PreAuthorize("hasPermission(#id, \'WORKSPACEITEM\', \'READ\')")
public WorkspaceItemRest findOne(Context context,
                                 Integer id)
```
    Description copied from class: DSpaceRestRepository
    
    Method to implement to support retrieval of a specific REST object instance
    
    Specified by:
    
    findOne in class DSpaceRestRepository<WorkspaceItemRest,Integer>
    
    Parameters:
    
    context - the dspace context
    
    id - the rest object id
    
    Returns:
    
    the REST object identified by its ID
  - findAll
```
@PreAuthorize("hasAuthority(\'ADMIN\')")
public org.springframework.data.domain.Page<WorkspaceItemRest> 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<WorkspaceItemRest,Integer>
    
    Parameters:
    
    context - the dspace context
    
    pageable - object embedding the requested pagination info
    
    Returns:
  - findBySubmitter
```
@PreAuthorize("hasPermission(#submitterID, \'EPERSON\', \'READ\')")
public org.springframework.data.domain.Page<WorkspaceItemRest> findBySubmitter(UUID submitterID,
                                                                               org.springframework.data.domain.Pageable pageable)
```
  - createAndReturn
```
protected WorkspaceItemRest createAndReturn(Context context)
                                     throws SQLException,
                                            AuthorizeException
```
    Description copied from class: DSpaceRestRepository
    
    Method to implement to support the creation of a new instance. Usually require to retrieve the http request from the thread bound attribute
    
    Overrides:
    
    createAndReturn in class DSpaceRestRepository<WorkspaceItemRest,Integer>
    
    Parameters:
    
    context - the dspace context
    
    Returns:
    
    the created REST object
    
    Throws:
    
    SQLException
    
    AuthorizeException
  - getDomainClass
```
public Class<WorkspaceItemRest> getDomainClass()
```
    Description copied from class: DSpaceRestRepository
    
    The REST model supported by the repository
    
    Specified by:
    
    getDomainClass in class DSpaceRestRepository<WorkspaceItemRest,Integer>
  - upload
```
@PreAuthorize("hasPermission(#id, \'WORKSPACEITEM\', \'WRITE\')")
public WorkspaceItemRest upload(javax.servlet.http.HttpServletRequest request,
                                String apiCategory,
                                String model,
                                Integer id,
                                org.springframework.web.multipart.MultipartFile file)
                         throws SQLException
```
    Description copied from class: DSpaceRestRepository
    
    Method to implement to attach/upload a file to a specific REST object
    
    Overrides:
    
    upload in class DSpaceRestRepository<WorkspaceItemRest,Integer>
    
    Parameters:
    
    request - the http request
    
    id - the ID of the target REST object
    
    file - the uploaded file
    
    Returns:
    
    the new state of the REST object
    
    Throws:
    
    SQLException
  - patch
```
@PreAuthorize("hasPermission(#id, \'WORKSPACEITEM\', \'WRITE\')")
public void patch(Context context,
                  javax.servlet.http.HttpServletRequest request,
                  String apiCategory,
                  String model,
                  Integer id,
                  Patch patch)
           throws SQLException,
                  AuthorizeException
```
    Description copied from class: DSpaceRestRepository
    
    Method to implement to allow partial update of the REST object via JSON Patch
    
    Overrides:
    
    patch in class DSpaceRestRepository<WorkspaceItemRest,Integer>
    
    request - the http request
    
    id - the ID of the target REST object
    
    patch - the JSON Patch (https://tools.ietf.org/html/rfc6902) operation
    
    Throws:
    
    SQLException
    
    AuthorizeException
  - delete
```
@PreAuthorize("hasPermission(#id, \'WORKSPACEITEM\', \'DELETE\')")
protected void delete(Context context,
                      Integer id)
               throws AuthorizeException
```
    Description copied from class: DSpaceRestRepository
    
    Method to implement to support delete of a single object instance
    
    Overrides:
    
    delete in class DSpaceRestRepository<WorkspaceItemRest,Integer>
    
    Parameters:
    
    context - the dspace context
    
    id - the id of the rest object to delete
    
    Throws:
    
    AuthorizeException
  - upload
```
public Iterable<WorkspaceItemRest> upload(Context context,
                                          javax.servlet.http.HttpServletRequest request,
                                          List<org.springframework.web.multipart.MultipartFile> uploadfiles)
                                   throws SQLException,
                                          FileNotFoundException,
                                          IOException,
                                          AuthorizeException
```
    Description copied from class: DSpaceRestRepository
    
    Method to implement to support bulk creation of objects from a file
    
    Overrides:
    
    upload in class DSpaceRestRepository<WorkspaceItemRest,Integer>
    
    request - the http request
    
    uploadfiles - the file to process
    
    Returns:
    
    the created objects
    
    Throws:
    
    SQLException
    
    FileNotFoundException
    
    IOException
    
    AuthorizeException
  - createAndReturn
```
protected WorkspaceItemRest createAndReturn(Context context,
                                            List<String> stringList)
                                     throws AuthorizeException,
                                            SQLException,
                                            RepositoryMethodNotImplementedException
```
    Description copied from class: DSpaceRestRepository
    
    Method to implement to support the creation of a new instance. Usually require to retrieve the http request from the thread bound attribute
    
    Overrides:
    
    createAndReturn in class DSpaceRestRepository<WorkspaceItemRest,Integer>
    
    Parameters:
    
    context - the dspace context
    
    stringList - The list of Strings that will be used as data for the object that's to be created This list is retrieved from the uri-list body
    
    Returns:
    
    the created REST object
    
    Throws:
    
    AuthorizeException
    
    SQLException
    
    RepositoryMethodNotImplementedException - returned by the default implementation when the operation is not supported for the entity
  - findByItemUuid
```
public WorkspaceItemRest findByItemUuid(UUID itemUuid,
                                        org.springframework.data.domain.Pageable pageable)
```
    This is a search method that will return the WorkspaceItemRest object found through the UUID of an item. It'll find the Item through the given UUID and try to resolve the WorkspaceItem relevant for that item and return it. It'll return a 401/403 if the current user isn't allowed to view the WorkspaceItem. It'll return a 204 if nothing was found
    
    Parameters:
    
    itemUuid - The UUID for the Item to be used
    
    pageable - The pageable if present
    
    Returns:
    
    The resulting WorkspaceItem object
  - findDomainObjectByPk
```
public WorkspaceItem findDomainObjectByPk(Context context,
                                          Integer id)
                                   throws SQLException
```
    Specified by:
    
    findDomainObjectByPk in interface ReloadableEntityObjectRepository<WorkspaceItem,Integer>
    
    Parameters:
    
    context - the DSpace context
    
    id - the primary key shared between the rest and dspace api object
    
    Returns:
    
    the dspace api model object related to the specified id
    
    Throws:
    
    SQLException - if a database error occurs
  - getPKClass
```
public Class<Integer> getPKClass()
```
    Specified by:
    
    getPKClass in interface ReloadableEntityObjectRepository<WorkspaceItem,Integer>
    
    Returns:
    
    the class of the primary key

Class WorkspaceItemRestRepository

Field Summary

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Field Detail

OPERATION_PATH_SECTIONS

Constructor Detail

WorkspaceItemRestRepository

Method Detail

findOne

findAll

findBySubmitter

createAndReturn

getDomainClass

upload

patch

delete

upload

createAndReturn

findByItemUuid

findDomainObjectByPk

getPKClass