This project has retired. For details please refer to its Attic page.
RelationshipService xref
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.commons.spi;
20  
21  import java.math.BigInteger;
22  
23  import org.apache.chemistry.opencmis.commons.data.ExtensionsData;
24  import org.apache.chemistry.opencmis.commons.data.ObjectList;
25  import org.apache.chemistry.opencmis.commons.enums.RelationshipDirection;
26  
27  /**
28   * Relationship Service interface.
29   * 
30   * <p>
31   * <em>
32   * See the CMIS 1.0 and CMIS 1.1 specifications for details on the operations, parameters,
33   * exceptions and the domain model.
34   * </em>
35   * </p>
36   */
37  public interface RelationshipService {
38  
39      /**
40       * Gets all or a subset of relationships associated with an independent
41       * object.
42       * 
43       * @param repositoryId
44       *            the identifier for the repository
45       * @param objectId
46       *            the object
47       * @param extension
48       *            extension data
49       * @return the list of relationships
50       */
51      ObjectList getObjectRelationships(String repositoryId, String objectId, Boolean includeSubRelationshipTypes,
52              RelationshipDirection relationshipDirection, String typeId, String filter, Boolean includeAllowableActions,
53              BigInteger maxItems, BigInteger skipCount, ExtensionsData extension);
54  }