eu.ehri.extension.base

Interface ParentResource

All Known Implementing Classes:

AuthoritativeSetResource, CountryResource, CvocConceptResource, DocumentaryUnitResource, RepositoryResource, VocabularyResource

public interface ParentResource

Methods for managing resources that have a subordinate (hierarchical) relationship to another resource.

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	createChild(String id, Bundle bundle, List<String> accessors) Create a subordinate resource.
javax.ws.rs.core.Response	listChildren(String id, boolean all) List available resources subordinate to this item.

Method Detail

listChildren

javax.ws.rs.core.Response listChildren(String id,
                                       boolean all)
                                throws ItemNotFound

List available resources subordinate to this item. Behaviour is the same as the general list method with respect to parameters.

Example:

     
 curl http://localhost:7474/ehri/[RESOURCE]/[ID]/list
     
 

Returns:

A list of serialized item representations

Throws:

ItemNotFound

createChild

javax.ws.rs.core.Response createChild(String id,
                                      Bundle bundle,
                                      List<String> accessors)
                               throws PermissionDenied,
                                      ValidationError,
                                      DeserializationError,
                                      ItemNotFound

Create a subordinate resource.

Parameters:

id - The parent resource ID.

bundle - A resource bundle.

accessors - The users/groups who can access this item.

Returns:

A serialized representation of the created resource.

Throws:

PermissionDenied

ValidationError

DeserializationError

ItemNotFound