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 references. Use this instead of <code>List&lt;DocumentRef&gt;</code> when a list of
028 * document references should be returned.
029 * <p>
030 * This object is type safe and can help services which need to dynamically discover which type of object is returned.
031 * (see operation framework for this)
032 * <p>
033 * This class is the equivalent of {@link DocumentModelList} but for document references.
034 *
035 * @author Bogdan Stefanescu
036 */
037public interface DocumentRefList extends List<DocumentRef>, Serializable {
038
039    /**
040     * Returns the total size of the bigger list this is a part of.
041     *
042     * @return the total size
043     */
044    long totalSize();
045
046}