001/*
002 *  Copyright 2016 Anyware Services
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 */
016package org.ametys.cms.content.external;
017
018import java.util.Set;
019
020import org.ametys.cms.repository.Content;
021
022/**
023 * This interface represents a provider of externalizable metadata for a content.
024 * 
025 */
026public interface ExternalizableMetadataProvider
027{
028    /**
029     * Enumeration for metadata status
030     *
031     */
032    public enum ExternalizableMetadataStatus
033    {
034        /** Status for a metadata for which the value to used is the external value */
035        EXTERNAL,
036        /** Status for a metadata for which the value to used is the local value */
037        LOCAL
038    }
039    
040    /**
041     * Get the path of metadata that are valued externally only.
042     * @param content The content
043     * @return The path of external metadata
044     */
045    public Set<String> getExternalOnlyMetadata (Content content);
046    
047    /**
048     * Get the path of metadata that can be valued externally or locally.
049     * @param content The content
050     * @return The path of external or local metadata
051     */
052    public Set<String> getExternalAndLocalMetadata (Content content);
053}