org.osid.bidding.rules

Interface AuctionConstrainerRuleLookupSession

All Superinterfaces:

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

public interface AuctionConstrainerRuleLookupSession
extends OsidSession

This session provides methods to retrieve AuctionConstrainer to Auction mappings. An Auction with multiple AuctionConstrainers means any positive rule evaluation across the result in an effective Auction.

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
• isolated auction house view: All methods in this session operate, retrieve and pertain auction constrainer defined explicitly in the current auction house
• federated auction house view: All methods in this session operate, retrieve and pertain to all auction constrainer defined in this auction house and any other auction constrainer implicitly available in this auction house through auction house inheritence.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupAuctionConstrainerRules() Tests if this user can perform lookups of auction constrainer/auction mappings.
IdList	getAuctionConstrainerIdsForAuction(Id auctionId) Gets the AuctionConstrainer Id associated with an Auction.
AuctionConstrainerList	getAuctionConstrainersForAuction(Id auctionId) Gets the AuctionConstrainer associated with an Auction.
AuctionHouse	getAuctionHouse() Gets the AuctionHouse associated with this session.
Id	getAuctionHouseId() Gets the AuctionHouse Id associated with this session.
IdList	getAuctionIdsForAuctionConstrainer(Id auctionConstrainerId) Gets the Auction Ids mapped to an AuctionConstrainer.
AuctionList	getAuctionsForAuctionConstrainer(Id auctionConstrainerId) Gets the Auctions mapped to an AuctionConstrainer.
void	useComparativeAuctionConstrainerRuleView() 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	useFederatedAuctionHouseView() Federates the view for methods in this session.
void	useIsolatedAuctionHouseView() Isolates the view for methods in this session.
void	usePlenaryAuctionConstrainerRuleView() A complete view of the AuctionConstrainer and Auction 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

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.

canLookupAuctionConstrainerRules

boolean canLookupAuctionConstrainerRules()

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

useComparativeAuctionConstrainerRuleView

void useComparativeAuctionConstrainerRuleView()

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.

usePlenaryAuctionConstrainerRuleView

void usePlenaryAuctionConstrainerRuleView()

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

useFederatedAuctionHouseView

void useFederatedAuctionHouseView()

Federates the view for methods in this session. A federated view will include auction constrainer in auction houses which are children of this auction house in the auction house hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedAuctionHouseView

void useIsolatedAuctionHouseView()

Isolates the view for methods in this session. An isolated view restricts lookups to this auction house only.

Compliance:

mandatory - This method is must be implemented.

getAuctionConstrainerIdsForAuction

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

Gets the AuctionConstrainer Id associated with an Auction.

Parameters:

auctionId - Id of the Auction

Returns:

the auction constrainer Ids

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.

getAuctionConstrainersForAuction

AuctionConstrainerList getAuctionConstrainersForAuction(Id auctionId)
                                                        throws NotFoundException,
                                                               OperationFailedException,
                                                               PermissionDeniedException

Gets the AuctionConstrainer associated with an Auction.

Parameters:

auctionId - Id of the Auction

Returns:

the auction constrainers

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.

getAuctionIdsForAuctionConstrainer

IdList getAuctionIdsForAuctionConstrainer(Id auctionConstrainerId)
                                          throws NotFoundException,
                                                 OperationFailedException,
                                                 PermissionDeniedException

Gets the Auction Ids mapped to an AuctionConstrainer.

Parameters:

auctionConstrainerId - Id of an AuctionConstrainer

Returns:

list of auction Ids

Throws:

NotFoundException - auctionConstrainerId is not found

NullArgumentException - auctionConstrainerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAuctionsForAuctionConstrainer

AuctionList getAuctionsForAuctionConstrainer(Id auctionConstrainerId)
                                             throws NotFoundException,
                                                    OperationFailedException,
                                                    PermissionDeniedException

Gets the Auctions mapped to an AuctionConstrainer.

Parameters:

auctionConstrainerId - Id of an AuctionConstrainer

Returns:

list of auctions

Throws:

NotFoundException - auctionConstrainerId is not found

NullArgumentException - auctionConstrainerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.