1 /*
2 * Copyright 2015 Data Archiving and Networked Services (an institute of
3 * Koninklijke Nederlandse Akademie van Wetenschappen), King's College London,
4 * Georg-August-Universitaet Goettingen Stiftung Oeffentlichen Rechts
5 *
6 * Licensed under the EUPL, Version 1.1 or – as soon they will be approved by
7 * the European Commission - subsequent versions of the EUPL (the "Licence");
8 * You may not use this work except in compliance with the Licence.
9 * You may obtain a copy of the Licence at:
10 *
11 * https://joinup.ec.europa.eu/software/page/eupl
12 *
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the Licence is distributed on an "AS IS" basis,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the Licence for the specific language governing
17 * permissions and limitations under the Licence.
18 */
19
20 package eu.ehri.extension.base;
21
22 import eu.ehri.project.exceptions.DeserializationError;
23 import eu.ehri.project.exceptions.ItemNotFound;
24 import eu.ehri.project.exceptions.PermissionDenied;
25 import eu.ehri.project.exceptions.ValidationError;
26 import eu.ehri.project.persistence.Bundle;
27
28 import javax.ws.rs.core.Response;
29 import java.util.List;
30
31 /**
32 * Methods for managing resources that have a subordinate (hierarchical)
33 * relationship to another resource.
34 */
35 public interface ParentResource {
36
37 /**
38 * List available resources subordinate to this item. Behaviour is the same
39 * as the general list method with respect to parameters.
40 * <p>
41 * Example:
42 * <pre>
43 * <code>
44 * curl http://localhost:7474/ehri/[RESOURCE]/[ID]/list
45 * </code>
46 * </pre>
47 *
48 * @return A list of serialized item representations
49 */
50 Response listChildren(String id, boolean all) throws ItemNotFound;
51
52 /**
53 * Create a subordinate resource.
54 *
55 * @param id The parent resource ID.
56 * @param bundle A resource bundle.
57 * @param accessors The users/groups who can access this item.
58 * @return A serialized representation of the created resource.
59 */
60 Response createChild(String id,
61 Bundle bundle, List<String> accessors)
62 throws PermissionDenied, ValidationError, DeserializationError, ItemNotFound;
63 }