fr.maxlego08.zauctionhouse.auction

Interface Auction

public interface Auction

Method Summary

Modifier and Type	Method and Description
void	addItem(AuctionItem item, ItemType type) Stores an item
void	buyItem(AuctionItem item, org.bukkit.entity.Player player) Buy an item
boolean	canBuy(org.bukkit.entity.Player player, AuctionItem item) Check if the player can buy the item
boolean	canSell(AuctionItem item) Check if item time has expired or not
boolean	canSell(org.bukkit.entity.Player player, long price) Check if the player can sell this item or not with the given price
boolean	canSellMoreItem(org.bukkit.entity.Player player) Check if the player can sell items
java.util.List<fr.maxlego08.zauctionhouse.zcore.utils.inventory.ConfigButton>	getButtons() Return buttons list
int	getBuying(org.bukkit.entity.Player player) Number purchased item for the player
java.util.List<AuctionItem>	getBuyingItems() List of items purchased
java.util.List<AuctionItem>	getBuyingItems(org.bukkit.entity.Player player) List of items purchased for a player
AuctionItem	getByID(long id) Search the item only in the list of items for sales
AuctionItem	getByUniqueID(long id) Search for items in all lists
int	getExpire(org.bukkit.entity.Player player) Number expired item for the player
java.util.List<AuctionItem>	getExpiredItems() List of items expired
java.util.List<AuctionItem>	getExpiredItems(org.bukkit.entity.Player player) List of items expired for a player
int	getItem(org.bukkit.entity.Player player) Number sales item for the player
java.util.List<AuctionItem>	getItems() List of items for sale
java.util.List<AuctionItem>	getItems(Category category) List of items according to a category
java.util.List<AuctionItem>	getItems(Category category, org.bukkit.entity.Player player) List of items according to a category
java.util.List<AuctionItem>	getItems(org.bukkit.entity.Player player) List of items for sale for a player
java.util.List<AuctionItem>	getItems(Sorting shorting) List of items for sale
java.util.List<AuctionItem>	getItemsFromSearch(java.lang.String name) List of items according to a category
java.util.List<AuctionItem>	getItemsSort(org.bukkit.entity.Player player)
int	getMaxPage(java.util.List<AuctionItem> item) Maximum number of pages for an item list
int	getMaxSellPerPermission(org.bukkit.entity.Player player) Maximum number of items the player can sell
java.lang.String	getPrice(AuctionItem item) Price of the item with the correct currency
java.lang.String	getPrice(AuctionItem item, long price) Price of the item with the correct currency
long	getPriceWithTaxe(long price) Price with the tax
java.util.Map<java.lang.String,Sorting>	getSort() Allows you to retrieve all the sortings of each player
Sorting	getSort(org.bukkit.entity.Player player)
Sorting	getSort(java.lang.String player)
ItemType	getType(long id)
void	giveItem(AuctionItem item, org.bukkit.entity.Player player, ItemType type, boolean updateInventory) Give an item to the player
void	initButtons() Create buttons for config
boolean	isBlackList(java.util.List<java.lang.String> lore) Check if the item is blacklist based on its lore
boolean	isBlackList(java.lang.String name) Check if the item is blacklisted by name
void	remove(AuctionItem item, ItemType type) Removes an item from storage
void	remove(AuctionItem item, org.bukkit.entity.Player player, boolean admin) Removes an item from sales
void	removeAll(org.bukkit.command.CommandSender sender, java.lang.String player)
void	sellItem(org.bukkit.inventory.ItemStack item, org.bukkit.entity.Player player, long price, Economy economy, int how) Sell an item
void	sendMessage(org.bukkit.entity.Player player, java.lang.String message, fr.maxlego08.zauctionhouse.zcore.utils.Message type) Send a message on days with different option enabled
void	setBuyingItems(java.util.List<AuctionItem> buyingItems) Put the list of purchased items
void	setExpiredItems(java.util.List<AuctionItem> expiredItems) Put the list of items expired
void	setItems(java.util.List<AuctionItem> items) Put the list of items
void	setSort(org.bukkit.entity.Player player, Sorting sorting)
void	updateBuying() Allows you to update purchased items, items that arrive at the end of the timer, will simply disappear
void	updateExpire() Allows you to update expired items, items that arrive at the end of the timer, will just disappear
void	updateItems() Allows you to update items for sale, items that are expired will go into item storage expired

Method Detail

addItem

void addItem(AuctionItem item,
             ItemType type)

Stores an item

Parameters:

item - that will be stored

type - of item

remove

void remove(AuctionItem item,
            ItemType type)

Removes an item from storage

Parameters:

item - that will be removed

type - of item

removeAll

void removeAll(org.bukkit.command.CommandSender sender,
               java.lang.String player)

Parameters:

sender -

player -

updateItems

void updateItems()

Allows you to update items for sale, items that are expired will go into item storage expired

updateExpire

void updateExpire()

Allows you to update expired items, items that arrive at the end of the timer, will just disappear

updateBuying

void updateBuying()

Allows you to update purchased items, items that arrive at the end of the timer, will simply disappear

setItems

void setItems(java.util.List<AuctionItem> items)

Put the list of items

Parameters:

items -

setBuyingItems

void setBuyingItems(java.util.List<AuctionItem> buyingItems)

Put the list of purchased items

Parameters:

buyingItems -

setExpiredItems

void setExpiredItems(java.util.List<AuctionItem> expiredItems)

Put the list of items expired

Parameters:

expiredItems -

sellItem

void sellItem(org.bukkit.inventory.ItemStack item,
              org.bukkit.entity.Player player,
              long price,
              Economy economy,
              int how)

Sell an item

Parameters:

item - that will be sold

player - who sells the item

price - of the item

if - the item uses playerpoint

the - number of items offered for sale

buyItem

void buyItem(AuctionItem item,
             org.bukkit.entity.Player player)

Buy an item

Parameters:

item - that will be purchased

player - who will buy the item

remove

void remove(AuctionItem item,
            org.bukkit.entity.Player player,
            boolean admin)

Removes an item from sales

Parameters:

Item - to be removed

player - who withdraws the item

if - the action is done by an admin

giveItem

void giveItem(AuctionItem item,
              org.bukkit.entity.Player player,
              ItemType type,
              boolean updateInventory)

Give an item to the player

Parameters:

item - that will be given

player - who will receive the item

type - of item

if - the inventory needs to be updated

sendMessage

void sendMessage(org.bukkit.entity.Player player,
                 java.lang.String message,
                 fr.maxlego08.zauctionhouse.zcore.utils.Message type)

Send a message on days with different option enabled

Parameters:

player -

message -

initButtons

void initButtons()

Create buttons for config

setSort

void setSort(org.bukkit.entity.Player player,
             Sorting sorting)

Parameters:

player -

sorting -

getPrice

java.lang.String getPrice(AuctionItem item)

Price of the item with the correct currency

Parameters:

item - that will be used

Returns:

the price of the item with the correct currency

getPrice

java.lang.String getPrice(AuctionItem item,
                          long price)

Price of the item with the correct currency

Parameters:

item - that will be used

price - that will be used

Returns:

the price of the item with the correct currency

getPriceWithTaxe

long getPriceWithTaxe(long price)

Price with the tax

Parameters:

price -

Returns:

the price with the tax

getExpire

int getExpire(org.bukkit.entity.Player player)

Number expired item for the player

Parameters:

player -

Returns:

the item number expired for the player

getBuying

int getBuying(org.bukkit.entity.Player player)

Number purchased item for the player

Parameters:

player -

Returns:

the number of items purchased for the player

getItem

int getItem(org.bukkit.entity.Player player)

Number sales item for the player

Parameters:

player -

Returns:

the number of items in sales for the player

getMaxSellPerPermission

int getMaxSellPerPermission(org.bukkit.entity.Player player)

Maximum number of items the player can sell

Parameters:

player -

Returns:

the maximum number of items the player can sell

getMaxPage

int getMaxPage(java.util.List<AuctionItem> item)

Maximum number of pages for an item list

Parameters:

item - list

Returns:

the maximum number of pages for an item list

getExpiredItems

java.util.List<AuctionItem> getExpiredItems(org.bukkit.entity.Player player)

List of items expired for a player

Parameters:

player -

Returns:

the list of items expired for a player

getBuyingItems

java.util.List<AuctionItem> getBuyingItems(org.bukkit.entity.Player player)

List of items purchased for a player

Parameters:

player -

Returns:

the list of items purchased for a player

getItems

java.util.List<AuctionItem> getItems(org.bukkit.entity.Player player)

List of items for sale for a player

Parameters:

player -

Returns:

list of items for sale for a player

getItems

java.util.List<AuctionItem> getItems(Category category)

List of items according to a category

Parameters:

category -

Returns:

the list of items according to a category

getItems

java.util.List<AuctionItem> getItems(Category category,
                                     org.bukkit.entity.Player player)

List of items according to a category

Parameters:

category -

Returns:

the list of items according to a category

getItemsFromSearch

java.util.List<AuctionItem> getItemsFromSearch(java.lang.String name)

List of items according to a category

Parameters:

category -

Returns:

the list of items according to a category

getItems

java.util.List<AuctionItem> getItems()

List of items for sale

Returns:

list of items for sale

getItems

java.util.List<AuctionItem> getItems(Sorting shorting)

List of items for sale

Returns:

list of items for sale

getItemsSort

java.util.List<AuctionItem> getItemsSort(org.bukkit.entity.Player player)

Parameters:

shorting -

Returns:

items sorted

getSort

java.util.Map<java.lang.String,Sorting> getSort()

Allows you to retrieve all the sortings of each player

Returns:

map of string and sorting

getSort

Sorting getSort(org.bukkit.entity.Player player)

Parameters:

player -

Returns:

sorting

getSort

Sorting getSort(java.lang.String player)

Parameters:

player -

Returns:

sorting

getExpiredItems

java.util.List<AuctionItem> getExpiredItems()

List of items expired

Returns:

the list of items expired

getBuyingItems

java.util.List<AuctionItem> getBuyingItems()

List of items purchased

Returns:

the list of items purchased

getButtons

java.util.List<fr.maxlego08.zauctionhouse.zcore.utils.inventory.ConfigButton> getButtons()

Return buttons list

Returns:

buttons

canSell

boolean canSell(AuctionItem item)

Check if item time has expired or not

Parameters:

item -

Returns:

true if the item can be sold

canSell

boolean canSell(org.bukkit.entity.Player player,
                long price)

Check if the player can sell this item or not with the given price

Parameters:

player -

selling - price

Returns:

true if the player can sell an item based on the given price

isBlackList

boolean isBlackList(java.lang.String name)

Check if the item is blacklisted by name

Parameters:

name -

Returns:

true if the item is blacklisted by name

isBlackList

boolean isBlackList(java.util.List<java.lang.String> lore)

Check if the item is blacklist based on its lore

Parameters:

lore -

Returns:

true if the item is blacklist based on its lore

canBuy

boolean canBuy(org.bukkit.entity.Player player,
               AuctionItem item)

Check if the player can buy the item

Parameters:

player -

item -

Returns:

true if the player has money to buy the item

canSellMoreItem

boolean canSellMoreItem(org.bukkit.entity.Player player)

Check if the player can sell items

Parameters:

player -

Returns:

true if the player can still sell items

getByID

AuctionItem getByID(long id)

Search the item only in the list of items for sales

Parameters:

id -

Returns:

the item according to its id, can be null if the item has not found

getByUniqueID

AuctionItem getByUniqueID(long id)

Search for items in all lists

Parameters:

id -

Returns:

the item according to its id, can be null if the item has not found

getType

ItemType getType(long id)

Parameters:

id -

Returns:

the type of the item, the default type is STORAGE