1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19 package org.apache.chemistry.opencmis.client.api;
20
21 /**
22 * CMIS relationship interface.
23 *
24 * @cmis 1.0
25 */
26 public interface Relationship extends CmisObject, RelationshipProperties {
27
28 /**
29 * Returns the object type as a relationship type.
30 *
31 * @return the relationship type
32 *
33 * @throws ClassCastException
34 * if the object type is not a relationship type
35 *
36 * @cmis 1.0
37 */
38 RelationshipType getRelationshipType();
39
40 /**
41 * Gets the source object. If the source object ID is invalid, {@code null}
42 * will be returned.
43 *
44 * @cmis 1.0
45 */
46 CmisObject getSource();
47
48 /**
49 * Gets the source object using the given {@link OperationContext}. If the
50 * source object ID is invalid, {@code null} will be returned.
51 *
52 * @cmis 1.0
53 */
54 CmisObject getSource(OperationContext context);
55
56 /**
57 * Gets the target object. If the target object ID is invalid, {@code null}
58 * will be returned.
59 *
60 * @cmis 1.0
61 */
62 CmisObject getTarget();
63
64 /**
65 * Gets the target object using the given {@link OperationContext}. If the
66 * target object ID is invalid, {@code null} will be returned.
67 *
68 * @cmis 1.0
69 */
70 CmisObject getTarget(OperationContext context);
71 }