001/*
002 * (C) Copyright 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 *     Anahide Tchertchian
018 */
019package org.nuxeo.ecm.platform.forms.layout.api.converters;
020
021import org.nuxeo.ecm.platform.forms.layout.api.LayoutDefinition;
022
023/**
024 * Converter for a layout definition.
025 *
026 * @since 5.5
027 */
028public interface LayoutDefinitionConverter {
029
030    /**
031     * Returns the original layout definition, or a clone if it needs to be changed. Can also return null if layout
032     * should be removed.
033     */
034    LayoutDefinition getLayoutDefinition(LayoutDefinition orig, LayoutConversionContext ctx);
035
036}