org.osid.bidding

Interface AuctionAuctionHouseSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface AuctionAuctionHouseSession
extends OsidSession

This session provides methods to retrieve Auction to AuctionHouse mappings. An Auction 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

Methods

Modifier and Type	Method and Description
boolean	canLookupAuctionAuctionHouseMappings() Tests if this user can perform lookups of auction/auction house mappings.
IdList	getAuctionHouseIdsByAuction(Id auctionId) Gets the AuctionHouse Ids mapped to an Auction.
AuctionHouseList	getAuctionHousesByAuction(Id auctionId) Gets the AuctionHouses mapped to an Auction.
IdList	getAuctionIdsByAuctionHouse(Id auctionHouseId) Gets the list of Auction Ids associated with an AuctionHouse.
IdList	getAuctionIdsByAuctionHouses(IdList auctionHouseIds) Gets the list of Auction Ids corresponding to a list of Auction Houses.
AuctionList	getAuctionsByAuctionHouse(Id auctionHouseId) Gets the list of Auctions associated with an AuctionHouse.
AuctionList	getAuctionsByAuctionHouses(IdList auctionHouseIds) Gets the list of Auction corresponding to a list of Auction Houses.
void	useComparativeAuctionAuctionHouseView() 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	usePlenaryAuctionAuctionHouseView() A complete view of the Auction and AuctionHouse returns is desired.

Methods inherited from interface org.osid.OsidSession

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

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

canLookupAuctionAuctionHouseMappings

boolean canLookupAuctionAuctionHouseMappings()

Tests if this user can perform lookups of auction/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.

useComparativeAuctionAuctionHouseView

void useComparativeAuctionAuctionHouseView()

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.

usePlenaryAuctionAuctionHouseView

void usePlenaryAuctionAuctionHouseView()

A complete view of the Auction 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.

getAuctionIdsByAuctionHouse

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

Gets the list of Auction Ids associated with an AuctionHouse.

Parameters:

auctionHouseId - Id of the AuctionHouse

Returns:

list of related auction 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.

getAuctionsByAuctionHouse

AuctionList getAuctionsByAuctionHouse(Id auctionHouseId)
                                      throws NotFoundException,
                                             OperationFailedException,
                                             PermissionDeniedException

Gets the list of Auctions associated with an AuctionHouse.

Parameters:

auctionHouseId - Id of the AuctionHouse

Returns:

list of related auctions

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.

getAuctionIdsByAuctionHouses

IdList getAuctionIdsByAuctionHouses(IdList auctionHouseIds)
                                    throws OperationFailedException,
                                           PermissionDeniedException

Gets the list of Auction Ids corresponding to a list of Auction Houses.

Parameters:

auctionHouseIds - list of auction house Ids

Returns:

list of auction Ids

Throws:

NullArgumentException - auctionHouseIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAuctionsByAuctionHouses

AuctionList getAuctionsByAuctionHouses(IdList auctionHouseIds)
                                       throws OperationFailedException,
                                              PermissionDeniedException

Gets the list of Auction corresponding to a list of Auction Houses.

Parameters:

auctionHouseIds - list of auction house Ids

Returns:

list of auctions

Throws:

NullArgumentException - auctionHouseIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAuctionHouseIdsByAuction

IdList getAuctionHouseIdsByAuction(Id auctionId)
                                   throws NotFoundException,
                                          OperationFailedException,
                                          PermissionDeniedException

Gets the AuctionHouse Ids mapped to an Auction.

Parameters:

auctionId - Id of an Auction

Returns:

list of auction houses

Throws:

NotFoundException - auctionId is not found

NullArgumentException - auctionId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAuctionHousesByAuction

AuctionHouseList getAuctionHousesByAuction(Id auctionId)
                                           throws NotFoundException,
                                                  OperationFailedException,
                                                  PermissionDeniedException

Gets the AuctionHouses mapped to an Auction.

Parameters:

auctionId - Id of an Auction

Returns:

list of auction houses

Throws:

NotFoundException - auctionId is not found

NullArgumentException - auctionId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.