hazza/DSpace
1
0
Fork 0
mirror of https://github.com/DSpace/DSpace.git synced 2025-10-07 01:54:22 +00:00
Code Issues Packages Projects Releases Wiki Activity

[DS-3532] added javadoc to the linkRestRepositories for ParentCommunity Linking

Browse Source
This commit is contained in:
Raf Ponsaerts
2020-02-21 08:58:38 +01:00
parent 6447176f02
commit d79deb6e1e
2 changed files with 25 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/CollectionParentCommunityLinkRepository.java
View File

@@ -24,6 +24,9 @@ import org.springframework.data.domain.Pageable;
import org.springframework.data.rest.webmvc.ResourceNotFoundException;
import org.springframework.stereotype.Component;
/**
* LinkRepository for the ParentCommunity object for a Collection
*/
@Component(CollectionRest.CATEGORY + "." + CollectionRest.NAME + "." + CollectionRest.PARENT_COMMUNITY)
public class CollectionParentCommunityLinkRepository extends AbstractDSpaceRestRepository
implements LinkRestRepository {
@@ -31,6 +34,15 @@ public class CollectionParentCommunityLinkRepository extends AbstractDSpaceRestR
@Autowired
private CollectionService collectionService;
/**
* This method retrieves the ParentCommunity object for the Collection which is defined by the given collectionId
* It'll transform this Parent Community to a REST object and return this
* @param httpServletRequest The current request
* @param collectionId The given Collection UUID that will be used to find the Collection
* @param optionalPageable The pageable
* @param projection The current Projection
* @return The Parent Community REST object
*/
public CommunityRest getParentCommunity(@Nullable HttpServletRequest httpServletRequest,
UUID collectionId,
@Nullable Pageable optionalPageable,
@@ -38,10 +50,10 @@ public class CollectionParentCommunityLinkRepository extends AbstractDSpaceRestR
try {
Context context = obtainContext();
Collection collection = collectionService.find(context, collectionId);
Community parentCommunity = (Community) collectionService.getParentObject(context, collection);
if (collection == null) {
throw new ResourceNotFoundException("No such collection: " + collectionId);
}
Community parentCommunity = (Community) collectionService.getParentObject(context, collection);
return converter.toRest(parentCommunity, projection);
} catch (SQLException e) {
throw new RuntimeException(e);

12
dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/CommunityParentCommunityLinkRepository.java
View File

@@ -22,6 +22,9 @@ import org.springframework.data.domain.Pageable;
import org.springframework.data.rest.webmvc.ResourceNotFoundException;
import org.springframework.stereotype.Component;
/**
* LinkRepository for the ParentCommunity object for a Community
*/
@Component(CommunityRest.CATEGORY + "." + CommunityRest.NAME + "." + CommunityRest.PARENT_COMMUNITY)
public class CommunityParentCommunityLinkRepository extends AbstractDSpaceRestRepository
implements LinkRestRepository {
@@ -29,6 +32,15 @@ public class CommunityParentCommunityLinkRepository extends AbstractDSpaceRestRe
@Autowired
private CommunityService communityService;
/**
* This method retrieves the ParentCommunity object for the Community which is defined by the given communityId
* It'll transform this Parent Community to a REST object and return this
* @param httpServletRequest The current request
* @param communityId The given Community UUID that will be used to find the communityId
* @param optionalPageable The pageable
* @param projection The current Projection
* @return The Parent Community REST object
*/
public CommunityRest getParentCommunity(@Nullable HttpServletRequest httpServletRequest,
UUID communityId,
@Nullable Pageable optionalPageable,