trunk/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/data/ObjectInFolderList.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.commons.data;

import java.math.BigInteger;
import java.util.List;

/**
 * Represents the objects in a folder.
 */
public interface ObjectInFolderList extends ExtensionsData {

    /**
     * Returns the objects in the folder.
     * 
     * @return the objects in the folder, not {@code null}
     */
    List<ObjectInFolderData> getObjects();

    /**
     * Indicates if there are more objects in the folder.
     * 
     * @return {@code true} if there are more objects, {@code false} if there
     *         are not more objects, or {@code null} if the repository didn't
     *         provide this flag
     */
    Boolean hasMoreItems();

    /**
     * Returns the total number of the objects in the folder.
     * 
     * @return the total number of the objects in the folder or {@code null} if
     *         the repository didn't provide the number
     */
    BigInteger getNumItems();
}