org.osid.bidding.rules

Interface AuctionProcessorEnablerQuerySession

All Superinterfaces:

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

All Known Subinterfaces:

AuctionProcessorEnablerSearchSession

public interface AuctionProcessorEnablerQuerySession
extends OsidSession

This session provides methods for searching among AuctionProcessorEnabler objects. The search query is constructed using the AuctionProcessorEnablerQuery.

This session defines views that offer differing behaviors for searching.

• federated auction house view: searches include auction processor enablers in auction houses of which this auction house is an ancestor in the auction house hierarchy
• isolated auction house view: searches are restricted to auction processor enablers in this auction house

Auction processor enablers may have a query record indicated by their respective record types. The query record is accessed via the AuctionProcessorEnablerQuery.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canSearchAuctionProcessorEnablers() Tests if this user can perform AuctionProcessorEnabler lookups.
AuctionHouse	getAuctionHouse() Gets the AuctionHouse associated with this session.
Id	getAuctionHouseId() Gets the AuctionHouse Id associated with this session.
AuctionProcessorEnablerQuery	getAuctionProcessorEnablerQuery() Gets an auction processor enabler query.
AuctionProcessorEnablerList	getAuctionProcessorEnablersByQuery(AuctionProcessorEnablerQuery auctionProcessorEnablerQuery) Gets a list of AuctionProcessorEnablers matching the given search.
void	useFederatedAuctionHouseView() Federates the view for methods in this session.
void	useIsolatedAuctionHouseView() Isolates the view for methods in this session.

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.

canSearchAuctionProcessorEnablers

boolean canSearchAuctionProcessorEnablers()

Tests if this user can perform AuctionProcessorEnabler 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 search methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useFederatedAuctionHouseView

void useFederatedAuctionHouseView()

Federates the view for methods in this session. A federated view will include auction processor enablers in auction houses which are children of this broker 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.

getAuctionProcessorEnablerQuery

AuctionProcessorEnablerQuery getAuctionProcessorEnablerQuery()

Gets an auction processor enabler query.

Returns:

the auction processor enabler query

Compliance:

mandatory - This method must be implemented.

getAuctionProcessorEnablersByQuery

AuctionProcessorEnablerList getAuctionProcessorEnablersByQuery(AuctionProcessorEnablerQuery auctionProcessorEnablerQuery)
                                                               throws OperationFailedException,
                                                                      PermissionDeniedException

Gets a list of AuctionProcessorEnablers matching the given search.

Parameters:

auctionProcessorEnablerQuery - the auction processor enabler query

Returns:

the returned AuctionProcessorEnablerList

Throws:

NullArgumentException - auctionProcessorEnablerQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - auctionProcessorEnablerQuery is not of this service

Compliance:

mandatory - This method must be implemented.