Interface BidAuctionHouseSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface BidAuctionHouseSession
extends OsidSession

This session provides methods to retrieve Bid to AuctionHouse mappings. A Bid may appear in multiple AuctionHouse objects. Each auction house may have its own authorizations governing who is allowed to look at it.

This lookup session defines several views:

• comparative view: elements may be silently omitted or re-ordered
• plenary view: provides a complete result set or is an error condition

Method Summary

Modifier and Type	Method	Description
boolean	canLookupBidAuctionHouseMappings()	Tests if this user can perform lookups of bid/auction house mappings.
IdList	getAuctionHouseIdsByBid(Id bidId)	Gets the AuctionHouse Ids mapped to a Bid .
AuctionHouseList	getAuctionHousesByBid(Id bidId)	Gets the AuctionHouses mapped to a Bid .
IdList	getBidIdsByAuctionHouse(Id auctionHouseId)	Gets the list of Bid Ids associated with an AuctionHouse .
IdList	getBidIdsByAuctionHouses(IdList auctionHouseIds)	Gets the list of Bid Ids corresponding to a list of AuctionHouses .
BidList	getBidsByAuctionHouse(Id auctionHouseId)	Gets the list of Bids associated with an AuctionHouse .
BidList	getBidsByAuctionHouses(IdList auctionHouseIds)	Gets the list of Bid corresponding to a list of AuctionHouses .
void	useComparativeBidAuctionHouseView()	The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	usePlenaryBidAuctionHouseView()	A complete view of the Bid and AuctionHouse returns is desired.

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

canLookupBidAuctionHouseMappings

boolean canLookupBidAuctionHouseMappings()

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

Returns:

false if looking up mappings is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeBidAuctionHouseView

void useComparativeBidAuctionHouseView()

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

Compliance:

mandatory - This method is must be implemented.

usePlenaryBidAuctionHouseView

void usePlenaryBidAuctionHouseView()

A complete view of the Bid and AuctionHouse returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

Compliance:

mandatory - This method is must be implemented.

getBidIdsByAuctionHouse

IdList getBidIdsByAuctionHouse(Id auctionHouseId)
                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Bid Ids associated with an AuctionHouse .

Parameters:

auctionHouseId - Id of the AuctionHouse

Returns:

list of related bid Ids

Throws:

NotFoundException - auctionHouseId is not found

NullArgumentException - auctionHouseId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getBidsByAuctionHouse

BidList getBidsByAuctionHouse(Id auctionHouseId)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Bids associated with an AuctionHouse .

Parameters:

auctionHouseId - Id of the AuctionHouse

Returns:

list of related bids

Throws:

NotFoundException - auctionHouseId is not found

NullArgumentException - auctionHouseId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getBidIdsByAuctionHouses

IdList getBidIdsByAuctionHouses(IdList auctionHouseIds)
                         throws OperationFailedException,
PermissionDeniedException

Gets the list of Bid Ids corresponding to a list of AuctionHouses .

Parameters:

auctionHouseIds - list of auction house Ids

Returns:

list of bid Ids

Throws:

NullArgumentException - auctionHouseIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getBidsByAuctionHouses

BidList getBidsByAuctionHouses(IdList auctionHouseIds)
                        throws OperationFailedException,
PermissionDeniedException

Gets the list of Bid corresponding to a list of AuctionHouses .

Parameters:

auctionHouseIds - list of auction house Ids

Returns:

list of bids

Throws:

NullArgumentException - auctionHouseIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAuctionHouseIdsByBid

IdList getAuctionHouseIdsByBid(Id bidId)
                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the AuctionHouse Ids mapped to a Bid .

Parameters:

bidId - Id of a Bid

Returns:

list of auction houses

Throws:

NotFoundException - bidId is not found

NullArgumentException - bidId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAuctionHousesByBid

AuctionHouseList getAuctionHousesByBid(Id bidId)
                                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the AuctionHouses mapped to a Bid .

Parameters:

bidId - Id of a Bid

Returns:

list of auction houses

Throws:

NotFoundException - bidId is not found

NullArgumentException - bidId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.