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.project.models.base;
21
22 import com.tinkerpop.blueprints.Direction;
23 import com.tinkerpop.frames.Adjacency;
24 import eu.ehri.project.definitions.Ontology;
25 import eu.ehri.project.models.annotations.Dependent;
26 import eu.ehri.project.models.annotations.Fetch;
27
28 /**
29 * An entity that can have descriptions.
30 */
31 public interface Described extends PermissionScope, Linkable {
32
33 /**
34 * Add a description to this item.
35 *
36 * @param description a description frame
37 */
38 @Adjacency(label = Ontology.DESCRIPTION_FOR_ENTITY, direction = Direction.IN)
39 void addDescription(Description description);
40
41 /**
42 * Remove a description from this item.
43 *
44 * @param description a description frame
45 */
46 @Adjacency(label = Ontology.DESCRIPTION_FOR_ENTITY, direction = Direction.IN)
47 void removeDescription(Description description);
48
49 /**
50 * Fetch this item's descriptions.
51 *
52 * @return an iterable of description frames
53 */
54 @Fetch(Ontology.DESCRIPTION_FOR_ENTITY)
55 @Dependent
56 @Adjacency(label = Ontology.DESCRIPTION_FOR_ENTITY, direction = Direction.IN)
57 Iterable<Description> getDescriptions();
58 }