001/*
002 * (C) Copyright 2012 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 *     mcedica
018 */
019package org.nuxeo.ecm.core.api.propertiesmapping;
020
021import java.util.Map;
022
023import org.nuxeo.ecm.core.api.CoreSession;
024import org.nuxeo.ecm.core.api.DocumentModel;
025
026/**
027 * Service that allows to copy a set of metadata from a source to a target document
028 *
029 * @since 5.6
030 */
031public interface PropertiesMappingService {
032
033    /**
034     * Gets a map of xpaths defining properties on the target and source documents
035     *
036     * @param mappingName
037     * @return
038     */
039    Map<String, String> getMapping(String mappingName);
040
041    /**
042     * Copies the properties defined by the given xpaths in the mapping from the target to the source document. Assumes
043     * that the xpaths are valid.
044     *
045     * @param session
046     * @param sourceDoc
047     * @param targetDoc
048     * @param mappingName
049     */
050    void mapProperties(CoreSession session, DocumentModel sourceDoc, DocumentModel targetDoc, String mappingName);
051
052}