001/*
002 * (C) Copyright 2006-2011 Nuxeo SA (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * Contributors:
017 *     Bogdan Stefanescu
018 *     Florent Guillaume
019 */
020
021package org.nuxeo.ecm.core.api;
022
023import java.io.Serializable;
024import java.util.List;
025
026/**
027 * A serializable list of document models.
028 * <p>
029 * It may include information about which part of a bigger list it represents.
030 *
031 * @author Bogdan Stefanescu
032 * @author Florent Guillaume
033 */
034public interface DocumentModelList extends List<DocumentModel>, Serializable {
035
036    /**
037     * Returns the total size of the bigger list this is a part of.
038     *
039     * @return the total size
040     */
041    long totalSize();
042
043}