OSID Logo
OSID Specifications
bidding package
Version 3.0.0
Release Candidate Preview
Interfaceosid.bidding.MyAuctionSession
Implementsosid.OsidSession
Description

This session defines methods for accessing auctions bid by authenticated agent.

MethodgetAuctionHouseId
Description

Gets the AuctionHouse Id associated with this session.

Returnosid.id.Idthe AuctionHouse Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetAuctionHouse
Description

Gets the AuctionHouse associated with this session.

Returnosid.bidding.AuctionHousethe auction house
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanLookupMyAuctions
Description

Tests if this user can perform Item lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may not offer lookup operations to unauthorized users.

Returnboolean false if lookup methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetMyAuctions
Description

Gets all the auctions bid by this agent and the auctions in which this agent is a particpant.

Returnosid.bidding.AuctionListthe returned AuctionList
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetMyOpenAuctions
Description

Gets all the auctions open for bidding that have been bid on by this agent and the auctions in which this agent is a particpant.

Returnosid.bidding.AuctionListthe returned AuctionList
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetMyAuctionsForBidding
Description

Gets a list of auctions in which this agent may place another bid. A list of open auctions in which this agent is a participant and not already the highest bidder is returned. Ante auctions where it is the agent's turn are also returned.

Returnosid.bidding.AuctionListthe returned AuctionList
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetMyAuctionsByDate
Description

Gets all the auctions bid by this agent the auctions in which this agent is a particpant where the give date falls within the auction open dates inclusive.

Parametersosid.calendaring.DateTimedatestart of date range
Returnosid.bidding.AuctionListthe returned AuctionList
ErrorsNULL_ARGUMENT date is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetMyBids
Description

Gets all the bids made by this agent.

Returnosid.bidding.BidListthe returned Bid list
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetMyBidsByDate
Description

Gets all the bids bid this agent where the bids have a start effective date within the given date range inclusive.

Parametersosid.calendaring.DateTimestartstart of date range
osid.calendaring.DateTimeendend of date range
Returnosid.bidding.BidListthe returned BidList
ErrorsINVALID_ARGUMENT start is greater than end
NULL_ARGUMENT start or end is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetMyBidsForAuction
Description

Gets all the bids made by this agent for the given auction.

Parametersosid.id.IdauctionIdan Id of an Auction
Returnosid.bidding.BidListthe returned Bid list
ErrorsNOT_FOUND auctionId is bot found
NULL_ARGUMENT auctionId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetWinningBids
Description

Gets all the winning bids made by any agent.

Returnosid.bidding.BidListthe winning Bid list
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.