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 import java.util.List;
22
23 /**
24 * Change event list.
25 *
26 * @cmis 1.0
27 */
28 public interface ChangeEvents {
29
30 /**
31 * Returns the change log token if available.
32 *
33 * @return the latest change log token or {@code null} if it is not
34 * available.
35 */
36 String getLatestChangeLogToken();
37
38 /**
39 * Returns the change event list.
40 *
41 * @return the list of change events, not {@code null}
42 */
43 List<ChangeEvent> getChangeEvents();
44
45 /**
46 * Indicates whether are more change events or not.
47 *
48 * @return {@code true} is there are more change events, {@code false}
49 * otherwise
50 */
51 boolean getHasMoreItems();
52
53 /**
54 * Returns the total number of change events if available.
55 *
56 * @return the total number of change events or -1 if the total number is
57 * not available
58 */
59 long getTotalNumItems();
60 }