001/*
002 *  Copyright 2025 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.odf.content.code;
017
018import java.util.Optional;
019
020import org.ametys.cms.repository.Content;
021import org.ametys.runtime.i18n.I18nizableText;
022import org.ametys.runtime.plugin.component.Supporter;
023
024/**
025 * Interface for a provider of a ODF content display code
026 */
027public interface DisplayCodeProvider extends Supporter<Content>
028{
029    /**
030     * Retrieves the id of the content type.
031     * @return the id.
032     */
033    String getId();
034    
035    /**
036     * Get the label
037     * @return The label
038     */
039    public I18nizableText getLabel();
040    
041    /**
042     * Get the display code of this content
043     * @param content the content
044     * @return the display code
045     */
046    public Optional<String> getDisplayCode(Content content);
047    
048    /**
049     * Determines if the provider is active
050     * @return true if the provider is active
051     */
052    public default boolean isActive() 
053    {
054        return true;
055    }
056}