org.osid.bidding.rules

Interface AuctionConstrainerEnablerAuctionHouseSession

All Superinterfaces:

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

public interface AuctionConstrainerEnablerAuctionHouseSession
extends OsidSession

This session provides methods to retrieve AuctionConstrainerEnabler to AuctionHouse mappings. An AuctionConstrainerEnabler 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	canLookupAuctionConstrainerEnablerAuctionHouseMappings() Tests if this user can perform lookups of auction constrainer enabler/auction house mappings.
IdList	getAuctionConstrainerEnablerIdsByAuctionHouse(Id auctionHouseId) Gets the list of AuctionConstrainerEnablerIds associated with an AuctionHouse.
IdList	getAuctionConstrainerEnablerIdsByAuctionHouses(IdList auctionHouseIds) Gets the list of AuctionConstrainerEnabler Ids corresponding to a list of AuctionHouses.
AuctionConstrainerEnablerList	getAuctionConstrainerEnablersByAuctionHouse(Id auctionHouseId) Gets the list of auction constrainer enablers associated with an AuctionHouse.
AuctionConstrainerEnablerList	getAuctionConstrainerEnablersByAuctionHouses(IdList auctionHouseIds) Gets the list of auction constrainer enablers corresponding to a list of AuctionHouses.
IdList	getAuctionHouseIdsByAuctionConstrainerEnabler(Id auctionConstrainerEnablerId) Gets the AuctionHouse Ids mapped to an AuctionConstrainerEnabler.
AuctionHouseList	getAuctionHousesByAuctionConstrainerEnabler(Id auctionConstrainerEnablerId) Gets the AuctionHouses mapped to an AuctionConstrainerEnabler.
void	useComparativeAuctionConstrainerEnablerAuctionHouseView() 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	usePlenaryAuctionConstrainerEnablerAuctionHouseView() A complete view of the AuctionConstrainerEnabler 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

canLookupAuctionConstrainerEnablerAuctionHouseMappings

boolean canLookupAuctionConstrainerEnablerAuctionHouseMappings()

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

useComparativeAuctionConstrainerEnablerAuctionHouseView

void useComparativeAuctionConstrainerEnablerAuctionHouseView()

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.

usePlenaryAuctionConstrainerEnablerAuctionHouseView

void usePlenaryAuctionConstrainerEnablerAuctionHouseView()

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

getAuctionConstrainerEnablerIdsByAuctionHouse

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

Gets the list of AuctionConstrainerEnablerIds associated with an AuctionHouse.

Parameters:

auctionHouseId - Id of the AuctionHouse

Returns:

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

getAuctionConstrainerEnablersByAuctionHouse

AuctionConstrainerEnablerList getAuctionConstrainerEnablersByAuctionHouse(Id auctionHouseId)
                                                                          throws NotFoundException,
                                                                                 OperationFailedException,
                                                                                 PermissionDeniedException

Gets the list of auction constrainer enablers associated with an AuctionHouse.

Parameters:

auctionHouseId - Id of the AuctionHouse

Returns:

list of related auction constrainer enablers

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.

getAuctionConstrainerEnablerIdsByAuctionHouses

IdList getAuctionConstrainerEnablerIdsByAuctionHouses(IdList auctionHouseIds)
                                                      throws OperationFailedException,
                                                             PermissionDeniedException

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

Parameters:

auctionHouseIds - list of auction house Ids

Returns:

list of auction constrainer enabler Ids

Throws:

NullArgumentException - auctionHouseIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAuctionConstrainerEnablersByAuctionHouses

AuctionConstrainerEnablerList getAuctionConstrainerEnablersByAuctionHouses(IdList auctionHouseIds)
                                                                           throws OperationFailedException,
                                                                                  PermissionDeniedException

Gets the list of auction constrainer enablers corresponding to a list of AuctionHouses.

Parameters:

auctionHouseIds - list of auction house Ids

Returns:

list of auction constrainer enablers

Throws:

NullArgumentException - auctionHouseIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAuctionHouseIdsByAuctionConstrainerEnabler

IdList getAuctionHouseIdsByAuctionConstrainerEnabler(Id auctionConstrainerEnablerId)
                                                     throws NotFoundException,
                                                            OperationFailedException,
                                                            PermissionDeniedException

Gets the AuctionHouse Ids mapped to an AuctionConstrainerEnabler.

Parameters:

auctionConstrainerEnablerId - Id of an AuctionConstrainerEnabler

Returns:

list of auction houses

Throws:

NotFoundException - auctionConstrainerEnablerId is not found

NullArgumentException - auctionConstrainerEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAuctionHousesByAuctionConstrainerEnabler

AuctionHouseList getAuctionHousesByAuctionConstrainerEnabler(Id auctionConstrainerEnablerId)
                                                             throws NotFoundException,
                                                                    OperationFailedException,
                                                                    PermissionDeniedException

Gets the AuctionHouses mapped to an AuctionConstrainerEnabler.

Parameters:

auctionConstrainerEnablerId - Id of an AuctionConstrainerEnabler

Returns:

list of auction houses

Throws:

NotFoundException - auctionConstrainerEnablerId is not found

NullArgumentException - auctionConstrainerEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.