Interface MyAuctionSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface MyAuctionSession
extends OsidSession

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

Method Summary

Modifier and Type	Method	Description
boolean	canLookupMyAuctions()	Tests if this user can perform Item lookups.
AuctionHouse	getAuctionHouse()	Gets the AuctionHouse associated with this session.
Id	getAuctionHouseId()	Gets the AuctionHouse Id associated with this session.
AuctionList	getMyAuctions()	Gets all the auctions bid by this agent and the auctions in which this agent is a particpant.
AuctionList	getMyAuctionsForBidding()	Gets a list of auctions in which this agent may place another bid.
BidList	getMyBids()	Gets all the bids made by this agent.
BidList	getMyBidsByDate(DateTime start, DateTime end)	Gets all the bids bid this agent where the bids have a start effective date within the given date range inclusive.
BidList	getMyBidsForAuction(Id auctionId)	Gets all the bids made by this agent for the given auction.
AuctionList	getMyOpenAuctions()	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.
BidList	getWinningBids()	Gets all the winning bids made by any agent.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

getAuctionHouseId

Id getAuctionHouseId()

Gets the AuctionHouse Id associated with this session.

Returns:

the AuctionHouse Id associated with this session

Compliance:

mandatory - This method must be implemented.

getAuctionHouse

AuctionHouse getAuctionHouse()
                      throws OperationFailedException,
PermissionDeniedException

Gets the AuctionHouse associated with this session.

Returns:

the auction house

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canLookupMyAuctions

boolean canLookupMyAuctions()

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.

Returns:

false if lookup methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getMyAuctions

AuctionList getMyAuctions()
                   throws OperationFailedException,
PermissionDeniedException

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

Returns:

the returned AuctionList

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getMyOpenAuctions

AuctionList getMyOpenAuctions()
                       throws OperationFailedException,
PermissionDeniedException

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.

Returns:

the returned AuctionList

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getMyAuctionsForBidding

AuctionList getMyAuctionsForBidding()
                             throws OperationFailedException,
PermissionDeniedException

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.

Returns:

the returned AuctionList

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getMyBids

BidList getMyBids()
           throws OperationFailedException,
PermissionDeniedException

Gets all the bids made by this agent.

Returns:

the returned Bid list

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getMyBidsByDate

BidList getMyBidsByDate(DateTime start,
 DateTime end)
                 throws OperationFailedException,
PermissionDeniedException

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

Parameters:

start - start of date range

end - end of date range

Returns:

the returned BidList

Throws:

InvalidArgumentException - start is greater than end

NullArgumentException - start or end is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getMyBidsForAuction

BidList getMyBidsForAuction(Id auctionId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

auctionId - an Id of an Auction

Returns:

the returned Bid list

Throws:

NotFoundException - auctionId is bot found

NullArgumentException - auctionId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getWinningBids

BidList getWinningBids()
                throws OperationFailedException,
PermissionDeniedException

Gets all the winning bids made by any agent.

Returns:

the winning Bid list

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.