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;
21
22 import com.tinkerpop.blueprints.Direction;
23 import com.tinkerpop.frames.Adjacency;
24 import com.tinkerpop.frames.Property;
25 import eu.ehri.project.definitions.Ontology;
26 import eu.ehri.project.models.annotations.EntityType;
27 import eu.ehri.project.models.annotations.Mandatory;
28 import eu.ehri.project.models.base.Accessible;
29 import eu.ehri.project.models.base.Description;
30 import eu.ehri.project.models.base.Named;
31
32 /**
33 * Holds the information on a relationship specified in some Description,
34 * but without the target-end of the relationship being determined.
35 */
36 @EntityType(EntityClass.ACCESS_POINT)
37 public interface AccessPoint extends Accessible, Named {
38
39 /**
40 * Fetch the description to which this UR belongs.
41 *
42 * @return a description frame
43 */
44 @Mandatory
45 @Adjacency(label = Ontology.HAS_ACCESS_POINT, direction = Direction.IN)
46 Description getDescription();
47
48 /**
49 * Fetch the links which make up the body of this UR (if any.)
50 *
51 * @return an iterable of link frames
52 */
53 @Adjacency(label = Ontology.LINK_HAS_BODY, direction = Direction.IN)
54 Iterable<Link> getLinks();
55
56 /**
57 * Get the relationship type of this UR.
58 *
59 * @return A type string
60 */
61 @Mandatory
62 @Property(Ontology.ACCESS_POINT_TYPE)
63 AccessPointType getRelationshipType();
64 }
65
66
67
68