BranchService.java

/**
 * Copyright (C) 2011  JTalks.org Team
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 * This library 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
 * Lesser General Public License for more details.
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */
package org.jtalks.poulpe.service;

import org.jtalks.common.service.EntityService;
import org.jtalks.poulpe.model.entity.PoulpeBranch;

import java.util.List;

/**
 * Service for dealing with {@link PoulpeBranch} objects
 * 
 * @author Vitaliy Kravchenko
 * @author Kirill Afonin
 * @author Vyacheslav Zhivaev
 */
public interface BranchService extends EntityService<PoulpeBranch> {

    /**
     * @return list of all {@link PoulpeBranch} objects
     */
    List<PoulpeBranch> getAll();

    /**
     * Save or update branch.
     * 
     * @param selectedBranch instance to save
     */
    void saveBranch(PoulpeBranch selectedBranch);

    /**
     * Removes all topics inside {@code victim} and then removes {@code victim} branch itself.
     * 
     * @param victim the branch to be removed
     */
    void deleteBranchRecursively(PoulpeBranch victim);

    /**
     * Moves all topics inside {@code victim} to another {@code recipient} branch and then removes {@code victim}
     * branch.
     * 
     * @param victim the branch to be removed
     * @param recipient the branch to take topics of {@code victim}
     */
    void deleteBranchMovingTopics(PoulpeBranch victim, PoulpeBranch recipient);

}