GroupAPI.java

/*
 * This file is part of mmoMinecraft (https://github.com/mmoMinecraftDev).
 *
 * mmoMinecraft is free software: you can redistribute it and/or modify
 * it under the terms of the GNU 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package mmo.Core.GroupAPI;

import java.util.List;
import org.bukkit.entity.Player;

public interface Group {

    // Finding groups

    public Group findGroup(String id);

    public Group getParent();

    public boolean isParent(Group group);

    public List<Group> getChildren();

    public boolean isChild(Group group);

    public List<Group> require();

    public List<Group> exclude();

    // Finding groups from players

    public List<Group> find(Player player);

    public List<Group> find(Player player, Group parent);

    public List<Group> find(Player player, Group parent, int depth);

    public boolean isMember(Player player);

    public boolean isOwnMember(Player player);

    // Adjust membership

    public boolean canInvite(Player from, Player to);

    public boolean invite(Player from, Player to);

    public boolean accept(Player player);

    public boolean canJoin(Player player);

    public boolean join(Player player);

    public boolean canLeave(Player player);

    public boolean leave(Player player);

    public boolean canKick(Player from, Player to);

    public boolean kick(Player from, Player to);

    // Adjust current members

    public boolean canPromote(Player from, Player to);

    public boolean promote(Player from, Player to);

    public boolean canDemote(Player from, Player to);

    public boolean demote(Player from, Player to);

    // Basic info about the group

    public String getId();

    public String getName();

    public List<String> getMembers();

    public String getCategory();

    // Metadata

    // Copy setXyz methods from mmoPlugin - same as old Configuration
}