001/*
002 * Copyright (c) 2006-2011 Nuxeo SA (http://nuxeo.com/) and others.
003 *
004 * All rights reserved. This program and the accompanying materials
005 * are made available under the terms of the Eclipse Public License v1.0
006 * which accompanies this distribution, and is available at
007 * http://www.eclipse.org/legal/epl-v10.html
008 *
009 * Contributors:
010 *     Bogdan Stefanescu
011 *     Florent Guillaume
012 */
013
014package org.nuxeo.ecm.core.api;
015
016import java.io.Serializable;
017import java.util.List;
018
019/**
020 * A serializable list of document references. Use this instead of <code>List&lt;DocumentRef&gt;</code> when a list of
021 * document references should be returned.
022 * <p>
023 * This object is type safe and can help services which need to dynamically discover which type of object is returned.
024 * (see operation framework for this)
025 * <p>
026 * This class is the equivalent of {@link DocumentModelList} but for document references.
027 *
028 * @author Bogdan Stefanescu
029 */
030public interface DocumentRefList extends List<DocumentRef>, Serializable {
031
032    /**
033     * Returns the total size of the bigger list this is a part of.
034     *
035     * @return the total size
036     */
037    long totalSize();
038
039}