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