IElephantCleanup.java

Go to the documentation of this file.

/*
 * Turró i Cutiller Foundation. License notice.
 * Copyright (C) 2022 Lluis Turró Cutiller <http://www.turro.org/>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package org.turro.cleanup;
 
import java.util.Set;
 
public interface IElephantCleanup {
  
  public static enum Commons {
    ATTACHMENTS,
    PUBLISHABLEFILES,
    PRIVATEFILES,
    PARTICIPATIONS,
    TAGS,
    SKILLS,
    RELATED,
    LOGS;
  }
  
  public boolean isMine(Object entity);
 
  public void setConsole(ICleanupConsole console);
  
  public void cleanEntity(Object entity, CleanupMode mode);
  public void cleanOrphans();  
  
  /* Commons by entityPath */
  public Set<String> pathsForRoot(String root, Commons common);
  public void cleanFromCommons(String entityPath, CleanupMode mode, Set<Commons> commons);
 
}