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 *     Thierry Delprat
018 */
019package org.nuxeo.template.api.context;
020
021import java.util.Map;
022
023import org.nuxeo.ecm.core.api.DocumentModel;
024
025/**
026 * Factory used to register new Context Extensions The resturned Object will be directly accessible inside the Rendering
027 * context
028 *
029 * @author <a href="mailto:[email protected]">Tiry</a>
030 */
031public interface ContextExtensionFactory {
032
033    /**
034     * Called before redering to let you add objects inside the rendering context.
035     * <p>
036     * If the method returns an object, it will be automatically pushed inside the context using the name defined in the
037     * contribution.
038     * </p>
039     * <p>
040     * you can also directly push in the provided ctx map
041     * </p>
042     *
043     * @param currentDocument
044     * @param wrapper
045     * @param ctx
046     * @return
047     */
048    Object getExtension(DocumentModel currentDocument, DocumentWrapper wrapper, Map<String, Object> ctx);
049}