trunk/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/ChangeEvents.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.apache.chemistry.opencmis.client.api;

import java.util.List;

/**
 * Change event list.
 * 
 * @cmis 1.0
 */
public interface ChangeEvents {

    /**
     * Returns the change log token if available.
     * 
     * @return the latest change log token or {@code null} if it is not
     *         available.
     */
    String getLatestChangeLogToken();

    /**
     * Returns the change event list.
     * 
     * @return the list of change events, not {@code null}
     */
    List<ChangeEvent> getChangeEvents();

    /**
     * Indicates whether are more change events or not.
     * 
     * @return {@code true} is there are more change events, {@code false}
     *         otherwise
     */
    boolean getHasMoreItems();

    /**
     * Returns the total number of change events if available.
     * 
     * @return the total number of change events or -1 if the total number is
     *         not available
     */
    long getTotalNumItems();
}