View Javadoc

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   * Accessors to CMIS relationship properties.
23   * 
24   * @see CmisObjectProperties
25   */
26  public interface RelationshipProperties {
27  
28      /**
29       * Returns the source ID of this CMIS relationship (CMIS property
30       * {@code cmis:sourceId}).
31       * 
32       * @return the source ID or {@code null} if the property hasn't been
33       *         requested, hasn't been provided by the repository, or the
34       *         property value isn't set
35       * 
36       * @cmis 1.0
37       */
38      ObjectId getSourceId();
39  
40      /**
41       * Returns the target ID of this CMIS relationship (CMIS property
42       * {@code cmis:targetId}).
43       * 
44       * @return the target ID or {@code null} if the property hasn't been
45       *         requested, hasn't been provided by the repository, or the
46       *         property value isn't set
47       * 
48       * @cmis 1.0
49       */
50      ObjectId getTargetId();
51  }