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.plugins.repository.trash;
017
018/**
019 * Interface for a component able to instantiate a {@link TrashElement}
020 */
021public interface TrashElementDAO
022{
023    /** The avalon role */
024    public static final String ROLE = TrashElementDAO.class.getName();
025
026    /**
027     * Instantiate a new trash element where the ametys object can store
028     * data to be able to restore itself later
029     * @param ametysObject the ametys object to trash
030     * @param title the title of the element
031     * @return the trash element
032     */
033    public TrashElement createTrashElement(TrashableAmetysObject ametysObject, String title);
034}