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 *     bstefanescu
011 */
012package org.nuxeo.ecm.automation.core.util;
013
014import org.nuxeo.ecm.core.api.DocumentModel;
015import org.nuxeo.ecm.core.api.DocumentModelList;
016
017/**
018 * @author <a href="mailto:bs@nuxeo.com">Bogdan Stefanescu</a>
019 */
020public interface PaginableDocumentModelList extends DocumentModelList, Paginable<DocumentModel> {
021
022    public static final String CODEC_PARAMETER_NAME = "URLCodecName";
023
024    /**
025     * Returns the name of what will be used to compute the document URLs, usually a codec name.
026     *
027     * @since 5.6
028     */
029    String getDocumentLinkBuilder();
030
031}