Interface ITeam
public interface ITeam
Interface for defining the structure and functionality of a team in a plugin environment.
This interface provides a standard way to manage teams, including their names, hierarchy, and relationships.
Implementing this interface allows different plugins to create and manage their own team logic, structures, and hierarchies.
- Since:
- 2023-11-20
- Version:
- 1.0.0
- Author:
- notzune
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addChildTeam
(ITeam team) Adds a child team to this team.Gets a list of child teams associated with this team.getName()
Retrieves the name of the team.Retrieves the parent team of this team, if any.void
removeChildTeam
(ITeam team) Removes a specific child team from this team.void
Sets the name of the team.void
setParentTeam
(ITeam parent) Sets the parent team for this team.
-
Method Details
-
getName
String getName()Retrieves the name of the team. This method should return the current name under which the team is recognized.- Returns:
- The name of the team as a String.
-
setName
Sets the name of the team. This method is used to change the team's name.- Parameters:
name
- The new name of the team as a String.
-
getChildTeams
Gets a list of child teams associated with this team. Child teams represent sub-groups or divisions within the larger team structure.- Returns:
- A list of ITeam instances representing the child teams.
-
addChildTeam
Adds a child team to this team. This method is used to expand the team hierarchy by adding a new sub-team.- Parameters:
team
- The ITeam instance representing the child team to be added.
-
removeChildTeam
Removes a specific child team from this team. This method allows for the dynamic reorganization or simplification of the team structure.- Parameters:
team
- The ITeam instance representing the child team to be removed.
-
getParentTeam
ITeam getParentTeam()Retrieves the parent team of this team, if any. The parent team is the higher-level team to which this team belongs. A return value of null indicates that this team is at the top of its hierarchy.- Returns:
- The ITeam instance representing the parent team, or null if there is no parent.
-
setParentTeam
Sets the parent team for this team. This method establishes or updates the hierarchical relationship of this team within a larger team structure.- Parameters:
parent
- The ITeam instance representing the new parent team.
-