org.osid.bidding.rules

Interface AuctionConstrainerLookupSession

All Superinterfaces:

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

public interface AuctionConstrainerLookupSession
extends OsidSession

This session provides methods for retrieving AuctionConstrainers.

This session defines views that offer differing behaviors when retrieving multiple objects.

• comparative view: elements may be silently omitted or re-ordered
• plenary view: provides a complete set or is an error condition
• isolated auction house view: All auction constrainer methods in this session operate, retrieve and pertain to auction constrainer defined explicitly in the current auction house. Using an isolated view is useful for managing AuctionConstrainers with the AuctionConstrainerAdminSession.
• federated auction house view: All auction constrainer 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.
• active auction constrainer view: All auction constrainer lookup methods return active auction constrainers.
• any status auction constrainer view: Auction constrainers of any active or inactive status are returned from methods.

Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. The methods useFederatedDistributorView() and useIsolatedDistributorView() behave as a radio group and one should be selected before invoking the methods in this session.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupAuctionConstrainers() Tests if this user can perform AuctionConstrainers lookups.
AuctionConstrainer	getAuctionConstrainer(Id auctionConstrainerId) Gets the AuctionConstrainer specified by its Id.
AuctionConstrainerList	getAuctionConstrainers() Gets all AuctionConstrainers.
AuctionConstrainerList	getAuctionConstrainersByGenusType(Type auctionConstrainerGenusType) Gets an AuctionConstrainerList corresponding to the given auction constrainer genus Type which does not include auction constrainer of genus types derived from the specified Type.
AuctionConstrainerList	getAuctionConstrainersByIds(IdList auctionConstrainerIds) Gets an AuctionConstrainerList corresponding to the given IdList.
AuctionConstrainerList	getAuctionConstrainersByParentGenusType(Type auctionConstrainerGenusType) Gets an AuctionConstrainerList corresponding to the given auction constrainer genus Type and include any additional auction constrainer with genus types derived from the specified Type.
AuctionConstrainerList	getAuctionConstrainersByRecordType(Type auctionConstrainerRecordType) Gets an AuctionConstrainerList containing the given auction constrainer record Type.
AuctionHouse	getAuctionHouse() Gets the AuctionHouse associated with this session.
Id	getAuctionHouseId() Gets the AuctionHouse Id associated with this session.
void	useActiveAuctionConstrainerView() Only active auction constrainers are returned by methods in this session.
void	useAnyStatusAuctionConstrainerView() All active and inactive auction constrainers are returned by methods in this session.
void	useComparativeAuctionConstrainerView() 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	usePlenaryAuctionConstrainerView() A complete view of the AuctionConstrainer 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.

canLookupAuctionConstrainers

boolean canLookupAuctionConstrainers()

Tests if this user can perform AuctionConstrainers 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 opt not to offer lookup operations to unauthorized users.

Returns:

false if lookup methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeAuctionConstrainerView

void useComparativeAuctionConstrainerView()

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.

usePlenaryAuctionConstrainerView

void usePlenaryAuctionConstrainerView()

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

useActiveAuctionConstrainerView

void useActiveAuctionConstrainerView()

Only active auction constrainers are returned by methods in this session.

Compliance:

mandatory - This method is must be implemented.

useAnyStatusAuctionConstrainerView

void useAnyStatusAuctionConstrainerView()

All active and inactive auction constrainers are returned by methods in this session.

Compliance:

mandatory - This method is must be implemented.

getAuctionConstrainer

AuctionConstrainer getAuctionConstrainer(Id auctionConstrainerId)
                                         throws NotFoundException,
                                                OperationFailedException,
                                                PermissionDeniedException

Gets the AuctionConstrainer specified by its Id. In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned AuctionConstrainer may have a different Id than requested, such as the case where a duplicate Id was assigned to an AuctionConstrainer and retained for compatibility. In active mode, auction constrainers are returned that are currently active. In any status mode, active and inactive auction constrainers are returned.

Parameters:

auctionConstrainerId - Id of the AuctionConstrainer

Returns:

the auction constrainer

Throws:

NotFoundException - auctionConstrainerId not found

NullArgumentException - auctionConstrainerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

getAuctionConstrainersByIds

AuctionConstrainerList getAuctionConstrainersByIds(IdList auctionConstrainerIds)
                                                   throws NotFoundException,
                                                          OperationFailedException,
                                                          PermissionDeniedException

Gets an AuctionConstrainerList corresponding to the given IdList. In plenary mode, the returned list contains all of the auction constrainer specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible AuctionConstrainers may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, auction constrainers are returned that are currently active. In any status mode, active and inactive auction constrainers are returned.

Parameters:

auctionConstrainerIds - the list of Ids to retrieve

Returns:

the returned AuctionConstrainer list

Throws:

NotFoundException - an Id was not found

NullArgumentException - auctionConstrainerIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAuctionConstrainersByGenusType

AuctionConstrainerList getAuctionConstrainersByGenusType(Type auctionConstrainerGenusType)
                                                         throws OperationFailedException,
                                                                PermissionDeniedException

Gets an AuctionConstrainerList corresponding to the given auction constrainer genus Type which does not include auction constrainer of genus types derived from the specified Type. In plenary mode, the returned list contains all known auction constrainer or an error results. Otherwise, the returned list may contain only those auction constrainer that are accessible through this session. In active mode, auction constrainers are returned that are currently active. In any status mode, active and inactive auction constrainers are returned.

Parameters:

auctionConstrainerGenusType - an auction constrainer genus type

Returns:

the returned AuctionConstrainer list

Throws:

NullArgumentException - auctionConstrainerGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAuctionConstrainersByParentGenusType

AuctionConstrainerList getAuctionConstrainersByParentGenusType(Type auctionConstrainerGenusType)
                                                               throws OperationFailedException,
                                                                      PermissionDeniedException

Gets an AuctionConstrainerList corresponding to the given auction constrainer genus Type and include any additional auction constrainer with genus types derived from the specified Type. In plenary mode, the returned list contains all known auction constrainer or an error results. Otherwise, the returned list may contain only those auction constrainer that are accessible through this session. In active mode, auction constrainers are returned that are currently active. In any status mode, active and inactive auction constrainers are returned.

Parameters:

auctionConstrainerGenusType - an auction constrainer genus type

Returns:

the returned AuctionConstrainer list

Throws:

NullArgumentException - auctionConstrainerGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAuctionConstrainersByRecordType

AuctionConstrainerList getAuctionConstrainersByRecordType(Type auctionConstrainerRecordType)
                                                          throws OperationFailedException,
                                                                 PermissionDeniedException

Gets an AuctionConstrainerList containing the given auction constrainer record Type. In plenary mode, the returned list contains all known auction constrainer or an error results. Otherwise, the returned list may contain only those auction constrainer that are accessible through this session. In active mode, auction constrainers are returned that are currently active. In any status mode, active and inactive auction constrainers are returned.

Parameters:

auctionConstrainerRecordType - an auction constrainer record type

Returns:

the returned AuctionConstrainer list

Throws:

NullArgumentException - auctionConstrainerRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAuctionConstrainers

AuctionConstrainerList getAuctionConstrainers()
                                              throws OperationFailedException,
                                                     PermissionDeniedException

Gets all AuctionConstrainers. In plenary mode, the returned list contains all known auction constrainer or an error results. Otherwise, the returned list may contain only those auction constrainer that are accessible through this session. In active mode, auction constrainers are returned that are currently active. In any status mode, active and inactive auction constrainers are returned.

Returns:

the returned AuctionConstrainer list

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.