001/*
002 * Sonar, open source software quality management tool.
003 * Copyright (C) 2008-2012 SonarSource
004 * mailto:contact AT sonarsource DOT com
005 *
006 * Sonar is free software; you can redistribute it and/or
007 * modify it under the terms of the GNU Lesser General Public
008 * License as published by the Free Software Foundation; either
009 * version 3 of the License, or (at your option) any later version.
010 *
011 * Sonar is distributed in the hope that it will be useful,
012 * but WITHOUT ANY WARRANTY; without even the implied warranty of
013 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014 * Lesser General Public License for more details.
015 *
016 * You should have received a copy of the GNU Lesser General Public
017 * License along with Sonar; if not, write to the Free Software
018 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02
019 */
020package org.sonar.plugins.dbcleaner.api;
021
022import com.google.common.annotations.Beta;
023import org.sonar.api.BatchExtension;
024
025/**
026 * @since 2.14
027 */
028@Beta
029public interface PurgeTask extends BatchExtension {
030  /**
031   * Purges the data related to a tree of resources.
032   *
033   * Exceptions are logged and are not thrown again, so this method fails only on {@link Error}s.
034   *
035   * @param resourceId the root of the tree
036   * @return this
037   */
038  PurgeTask purge(long resourceId);
039
040  /**
041   * Completely deletes a tree of resources.
042   *
043   * @param resourceId the root of the tree
044   * @return this
045   */
046  PurgeTask delete(long resourceId);
047}