Package com.palmergames.bukkit.towny.invites

Interface InviteReceiver

All Superinterfaces:

Nameable

All Known Subinterfaces:

Inviteable

All Known Implementing Classes:

Government, Nation, Resident, Town

public interface InviteReceiver
extends Nameable

Represents a class that can receive invitations.

Author:

Articdive

Method Summary

Modifier and Type	Method	Description
void	deleteReceivedInvite(Invite invite)	Removes an invite from the received collection.
Collection<Invite>	getReceivedInvites()	Gets the collection of invites received.
void	newReceivedInvite(Invite invite)	Adds an invite to the received collection.

Methods inherited from interface com.palmergames.bukkit.towny.object.Nameable

getFormattedName, getName

Method Details

getReceivedInvites

Collection<Invite> getReceivedInvites()

Gets the collection of invites received.

Returns:

An unmodifiable collection of received invites.

newReceivedInvite

void newReceivedInvite(Invite invite)
                throws TooManyInvitesException

Adds an invite to the received collection.

Parameters:

invite - The invite to add.

Throws:

TooManyInvitesException - When the invite cap is reached.

deleteReceivedInvite

void deleteReceivedInvite(Invite invite)

Removes an invite from the received collection.

Parameters:

invite - The invite to remove.