TF-Marriage/src/main/java/com/lenis0012/bukkit/marriage2/MPlayer.java

package com.lenis0012.bukkit.marriage2;

import java.util.UUID;

import javax.annotation.Nullable;

public interface MPlayer {
	
	/**
	 * Get unique User Id of the player.
	 * 
	 * @return Player's unique user id.
	 */
	UUID getUniqueId();
	
	/**
	 * Request marriage with this player by another.
	 * 
	 * @param from Player who requested the marriage.
	 */
	void requestMarriage(UUID from);
	
	/**
	 * Check if marriage with this player is requested by another.
	 * 
	 * @param from Marriage requester.
	 * @return Whether or not marriage is requested by the player.
	 */
	boolean isMarriageRequested(UUID from);
	
	/**
	 * Get the player's gender.
	 * 
	 * @return Player's gender.
	 */
	Gender getGender();
	
	/**
	 * Set the player's gender.
	 * 
	 * @param gender Player's gender.
	 */
	void setGender(Gender gender);
	
	/**
	 * Get current marriage of the player.
	 * 
	 * @return Player's marriage, NULL if not married.
	 */
	@Nullable
	MData getMarriage();
	
	/**
	 * Check if the player is married.
	 * 
	 * @return True if married, false otherwise.
	 */
	boolean isMarried();
	
	/**
	 * Check if the player is in marry-chat mode.
	 * 
	 * @return True if in chat-mode, false otherwise.
	 */
	boolean isInChat();

	/**
	 * Whether or not the player is a priest.
	 *
	 * @return True if player ius priest, false otherwise
	 */
	boolean isPriest();

	/**
	 * Set whether or not this player is a priest.
	 *
	 * @param priest True if player is priest, false otherwise
	 */
	void setPriest(boolean priest);
	
	/**
	 * Set if the player is in marry chat-mode.
	 * 
	 * @param inChat Whether or not the player is in marry chat-mode.
	 */
	void setInChat(boolean inChat);
	
	/**
	 * Get the current player's partner
	 * 
	 * @return Current partner of the player
	 */
	MPlayer getPartner();
	
	/**
	 * Divorce with the current player's partner
	 */
	void divorce();

	long getLastLogin();

	long getLastLogout();
}