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.IncludeRelationships;
26
27 /**
28 * Discovery 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 DiscoveryService {
38
39 /**
40 * Executes a CMIS query statement against the contents of the repository.
41 *
42 * @param repositoryId
43 * the identifier for the repository
44 * @param statement
45 * the query statement
46 * @param extension
47 * extension data
48 * @return the query result
49 */
50 ObjectList query(String repositoryId, String statement, Boolean searchAllVersions, Boolean includeAllowableActions,
51 IncludeRelationships includeRelationships, String renditionFilter, BigInteger maxItems,
52 BigInteger skipCount, ExtensionsData extension);
53
54 /**
55 * Gets a list of content changes.
56 *
57 * @param repositoryId
58 * the identifier for the repository
59 * @param extension
60 * extension data
61 * @return the list of changes
62 */
63 ObjectList getContentChanges(String repositoryId, Holder<String> changeLogToken, Boolean includeProperties,
64 String filter, Boolean includePolicyIds, Boolean includeAcl, BigInteger maxItems, ExtensionsData extension);
65 }