001/*
002 *  Copyright 2023 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.plugins.workspaces.initialization;
017
018import java.util.Optional;
019
020import org.ametys.runtime.plugin.component.Prioritizable;
021import org.ametys.web.repository.page.ModifiableSitemapElement;
022import org.ametys.web.repository.page.Page;
023
024/**
025 * Interface for the creation of a new page with predefined content and configuration
026 * This can for example be use to generate some default pages during site initialization
027 */
028public interface PageInitializer extends Prioritizable
029{
030    /**
031     * Create a new page in the parent
032     * @param parent the parent where the new page should be created
033     * @return the new page or empty if no page was created
034     */
035    public Optional< ? extends Page> createPage(ModifiableSitemapElement parent);
036}