Use Cases - Auction System

1 Player open auction interface

Overview
A player opens the auction system interface.

Functions
AuctionStartUp(iPlayerId)

Events
OnAuctionStartUp(iAuctionItem, iItem, iQuantity, iAction, iPrice)

2 Player create an auction item

Overview
A player open the auction interface and decide to offer an item for sale, the player decide items, number of days the auction item should be valid and an optional buy out price.

Functions
AuctionStartUp(iPlayerId) AuctionCreateAuctionItem(iPlayerId, ItemId, iValidDays, iStartPrice, iBuyOutPrice, iAuctionItem)

Events
OnAuctionStartUp(iAuctionItem, iItem, iQuantity, iAction, iPrice) OnAuctionCreateAuctionItem(iAuctionItem)

3 Player examine an auction item and delete it

Overview
A player has an open auction interface, he select an auction item he has created and decide to delete the auction. A player can only delete auction item he has created, and if there are no bidders.

Functions
AuctionActivePlayerAuctions(iPlayerId) AuctionDeleteAuctionItem(iPlayerId, iAuctionItem)

Events
OnAuctionActivePlayerAuctions(iAuctionItem, iItem, iCurrentPrice, iBids, iBidder, sStartDate, sCloseDate, iBuyOutPrice) OnAuctionDelete(iResult)

4 Player search for a item and place a bid

Overview
A player has an open auction interface; he searches for a specific item (or type of item), finds an interesting auction item and places a bid.

Functions
AuctionSearchItem(iPlayerId, iItemId, iGroupId, iNbrOfHits) AuctionGetAuctionItem(iPlayerId, iAuctionItem) AuctionGetAuctionItemHistory(iPlayerId, iAuctionItem, iNbrOfBids) AuctionPlaceBid(iPlayerId, iAuctionItem, iBidPrice)

Events
OnAuctionSearchItem(iAuctionItem, iQuantity, iCurrentPrice, sValidUntil, sDescription) OnAuctionAuctionItemInfo(iAuctionItem, iItem, sCloseDate, iSeller) OnAuctionAuctionItemInfo2(iAuctionItem, iBidder, iCurrentPrice, iBids, iBuyOutPrice) OnAuctionGetAuctionItemHistory(iBidder, iPrice, sBidDate) OnAuctionPlaceBid(iAuctionItem, iStatus)