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 *     <a href="mailto:at@nuxeo.com">Anahide Tchertchian</a>
011 *
012 * $Id: DocumentTranslationMap.java 29029 2008-01-14 18:38:14Z ldoguin $
013 */
014
015package org.nuxeo.ecm.core.io;
016
017import java.util.Map;
018
019import org.nuxeo.ecm.core.api.DocumentRef;
020
021/**
022 * Translation map for exported/imported documents.
023 */
024public interface DocumentTranslationMap {
025
026    /**
027     * Returns the old documents server name.
028     */
029    String getOldServerName();
030
031    /**
032     * Returns the new documents server name.
033     */
034    String getNewServerName();
035
036    /**
037     * Returns the unmodifiable map of document references.
038     */
039    Map<DocumentRef, DocumentRef> getDocRefMap();
040
041    void put(DocumentRef oldRef, DocumentRef newRef);
042
043    void putAll(Map<DocumentRef, DocumentRef> refs);
044
045}