org.osid.bidding

Interface BiddingProfile

All Superinterfaces:

OsidProfile, Sourceable

All Known Subinterfaces:

BiddingManager, BiddingProxyManager

public interface BiddingProfile
extends OsidProfile

The bidding profile describes the interoperability among bidding services.

Method Summary

Methods

Modifier and Type	Method and Description
TypeList	getAuctionHouseRecordTypes() Gets the supported AuctionHouse record types.
TypeList	getAuctionHouseSearchRecordTypes() Gets the supported AuctionHouse search record types.
TypeList	getAuctionRecordTypes() Gets the supported Auction record types.
TypeList	getAuctionSearchRecordTypes() Gets the supported Auction search types.
TypeList	getBidRecordTypes() Gets the supported Bid record types.
TypeList	getBidSearchRecordTypes() Gets the supported Bid search record types.
boolean	supportsAuctionAdmin() Tests if an auction administrative service is supported.
boolean	supportsAuctionAuctionHouse() Tests if an auction auction house lookup service is supported.
boolean	supportsAuctionAuctionHouseAssignment() Tests if an auction auction house assignment service is supported.
boolean	supportsAuctionHouseAdmin() Tests if auction house administrative service is supported.
boolean	supportsAuctionHouseHierarchy() Tests for the availability of a auction house hierarchy traversal service.
boolean	supportsAuctionHouseHierarchyDesign() Tests for the availability of a auction house hierarchy design service.
boolean	supportsAuctionHouseLookup() Tests if looking up auction houses is supported.
boolean	supportsAuctionHouseNotification() Tests if a auction house notification service is supported.
boolean	supportsAuctionHouseQuery() Tests if querying auction houses is supported.
boolean	supportsAuctionHouseRecordType(Type auctionHouseRecordType) Tests if the given AuctionHouse record type is supported.
boolean	supportsAuctionHouseSearch() Tests if searching auction houses is supported.
boolean	supportsAuctionHouseSearchRecordType(Type auctionHouseSearchRecordType) Tests if the given AuctionHouse search record type is supported.
boolean	supportsAuctionLookup() Tests if looking up auctions is supported.
boolean	supportsAuctionNotification() Tests if an auction notification service is supported.
boolean	supportsAuctionQuery() Tests if querying auctions is supported.
boolean	supportsAuctionRecordType(Type auctionRecordType) Tests if the given Auction record type is supported.
boolean	supportsAuctionSearch() Tests if searching auctions is supported.
boolean	supportsAuctionSearchRecordType(Type auctionSearchRecordType) Tests if the given Auction search type is supported.
boolean	supportsAuctionSmartAuctionHouse() Tests if an auction smart auction house service is supported.
boolean	supportsBidAdmin() Tests if bid administrative service is supported.
boolean	supportsBidAuctionHouse() Tests if a bid auction house lookup service is supported.
boolean	supportsBidAuctionHouseAssignment() Tests if a bid auction house service is supported.
boolean	supportsBiddingBatch() Tests for the availability of a bidding batch service.
boolean	supportsBiddingRules() Tests for the availability of a bidding rules service.
boolean	supportsBidLookup() Tests if looking up bids is supported.
boolean	supportsBidNotification() Tests if a bid notification service is supported.
boolean	supportsBidQuery() Tests if querying bids is supported.
boolean	supportsBidRecordType(Type bidRecordType) Tests if the given Bid record type is supported.
boolean	supportsBidSearch() Tests if searching bids is supported.
boolean	supportsBidSearchRecordType(Type bidSearchRecordType) Tests if the given Bid search record type is supported.
boolean	supportsBidSmartAuctionHouse() Tests if a bid smart auction house lookup service is supported.
boolean	supportsMyAuction() Tests if a my auction service is supported for the current agent.
boolean	supportsMyAuctionNotification() Tests if a my auction notification service is supported for the current agent.
boolean	supportsVisibleFederation() Tests if any auction house federation is exposed.

Methods inherited from interface org.osid.OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

supportsVisibleFederation

boolean supportsVisibleFederation()

Tests if any auction house federation is exposed. Federation is exposed when a specific auction house may be identified, selected and used to create a lookup or admin session. Federation is not exposed when a set of auction houses appears as a single auction house.

Returns:

true if visible federation is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsMyAuction

boolean supportsMyAuction()

Tests if a my auction service is supported for the current agent.

Returns:

true if my auction is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsMyAuctionNotification

boolean supportsMyAuctionNotification()

Tests if a my auction notification service is supported for the current agent.

Returns:

true if my auction notification is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsAuctionLookup

boolean supportsAuctionLookup()

Tests if looking up auctions is supported.

Returns:

true if auction lookup is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsAuctionQuery

boolean supportsAuctionQuery()

Tests if querying auctions is supported.

Returns:

true if auction query is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsAuctionSearch

boolean supportsAuctionSearch()

Tests if searching auctions is supported.

Returns:

true if auction search is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsAuctionAdmin

boolean supportsAuctionAdmin()

Tests if an auction administrative service is supported.

Returns:

true if auction administration is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsAuctionNotification

boolean supportsAuctionNotification()

Tests if an auction notification service is supported.

Returns:

true if auction notification is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsAuctionAuctionHouse

boolean supportsAuctionAuctionHouse()

Tests if an auction auction house lookup service is supported.

Returns:

true if an auction auction house lookup service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsAuctionAuctionHouseAssignment

boolean supportsAuctionAuctionHouseAssignment()

Tests if an auction auction house assignment service is supported.

Returns:

true if an auction to auction house assignment service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsAuctionSmartAuctionHouse

boolean supportsAuctionSmartAuctionHouse()

Tests if an auction smart auction house service is supported.

Returns:

true if an v smart auction house service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsBidLookup

boolean supportsBidLookup()

Tests if looking up bids is supported.

Returns:

true if bid lookup is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsBidQuery

boolean supportsBidQuery()

Tests if querying bids is supported.

Returns:

true if bid query is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsBidSearch

boolean supportsBidSearch()

Tests if searching bids is supported.

Returns:

true if bid search is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsBidAdmin

boolean supportsBidAdmin()

Tests if bid administrative service is supported.

Returns:

true if bid administration is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsBidNotification

boolean supportsBidNotification()

Tests if a bid notification service is supported.

Returns:

true if bid notification is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsBidAuctionHouse

boolean supportsBidAuctionHouse()

Tests if a bid auction house lookup service is supported.

Returns:

true if a bid auction house lookup service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsBidAuctionHouseAssignment

boolean supportsBidAuctionHouseAssignment()

Tests if a bid auction house service is supported.

Returns:

true if bid to auction house assignment service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsBidSmartAuctionHouse

boolean supportsBidSmartAuctionHouse()

Tests if a bid smart auction house lookup service is supported.

Returns:

true if a bid smart auction house service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsAuctionHouseLookup

boolean supportsAuctionHouseLookup()

Tests if looking up auction houses is supported.

Returns:

true if auction house lookup is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsAuctionHouseQuery

boolean supportsAuctionHouseQuery()

Tests if querying auction houses is supported.

Returns:

true if a auction house query service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsAuctionHouseSearch

boolean supportsAuctionHouseSearch()

Tests if searching auction houses is supported.

Returns:

true if auction house search is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsAuctionHouseAdmin

boolean supportsAuctionHouseAdmin()

Tests if auction house administrative service is supported.

Returns:

true if auction house administration is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsAuctionHouseNotification

boolean supportsAuctionHouseNotification()

Tests if a auction house notification service is supported.

Returns:

true if auction house notification is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsAuctionHouseHierarchy

boolean supportsAuctionHouseHierarchy()

Tests for the availability of a auction house hierarchy traversal service.

Returns:

true if auction house hierarchy traversal is available, false otherwise

Compliance:

mandatory - This method must be implemented in all providers.

supportsAuctionHouseHierarchyDesign

boolean supportsAuctionHouseHierarchyDesign()

Tests for the availability of a auction house hierarchy design service.

Returns:

true if auction house hierarchy design is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsBiddingBatch

boolean supportsBiddingBatch()

Tests for the availability of a bidding batch service.

Returns:

true ifa bidding batch servicen is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsBiddingRules

boolean supportsBiddingRules()

Tests for the availability of a bidding rules service.

Returns:

true ifa bidding rules servicen is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAuctionRecordTypes

TypeList getAuctionRecordTypes()

Gets the supported Auction record types.

Returns:

a list containing the supported Auction record types

Compliance:

mandatory - This method must be implemented.

supportsAuctionRecordType

boolean supportsAuctionRecordType(Type auctionRecordType)

Tests if the given Auction record type is supported.

Parameters:

auctionRecordType - a Type indicating an Auction record type

Returns:

true if the given record type is supported, false otherwise

Throws:

NullArgumentException - auctionRecordType is null

Compliance:

mandatory - This method must be implemented.

getAuctionSearchRecordTypes

TypeList getAuctionSearchRecordTypes()

Gets the supported Auction search types.

Returns:

a list containing the supported Auction search types

Compliance:

mandatory - This method must be implemented.

supportsAuctionSearchRecordType

boolean supportsAuctionSearchRecordType(Type auctionSearchRecordType)

Tests if the given Auction search type is supported.

Parameters:

auctionSearchRecordType - a Type indicating an Auction search type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - auctionSearchRecordType is null

Compliance:

mandatory - This method must be implemented.

getBidRecordTypes

TypeList getBidRecordTypes()

Gets the supported Bid record types.

Returns:

a list containing the supported Bid record types

Compliance:

mandatory - This method must be implemented.

supportsBidRecordType

boolean supportsBidRecordType(Type bidRecordType)

Tests if the given Bid record type is supported.

Parameters:

bidRecordType - a Type indicating a Bid record type

Returns:

true if the given record type is supported, false otherwise

Throws:

NullArgumentException - bidRecordType is null

Compliance:

mandatory - This method must be implemented.

getBidSearchRecordTypes

TypeList getBidSearchRecordTypes()

Gets the supported Bid search record types.

Returns:

a list containing the supported Bid search record types

Compliance:

mandatory - This method must be implemented.

supportsBidSearchRecordType

boolean supportsBidSearchRecordType(Type bidSearchRecordType)

Tests if the given Bid search record type is supported.

Parameters:

bidSearchRecordType - a Type indicating a Bid search record type

Returns:

true if the given search record type is supported, false otherwise

Throws:

NullArgumentException - bidSearchRecordType is null

Compliance:

mandatory - This method must be implemented.

getAuctionHouseRecordTypes

TypeList getAuctionHouseRecordTypes()

Gets the supported AuctionHouse record types.

Returns:

a list containing the supported AuctionHouse types

Compliance:

mandatory - This method must be implemented.

supportsAuctionHouseRecordType

boolean supportsAuctionHouseRecordType(Type auctionHouseRecordType)

Tests if the given AuctionHouse record type is supported.

Parameters:

auctionHouseRecordType - a Type indicating a AuctionHouse record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - auctionHouseRecordType is null

Compliance:

mandatory - This method must be implemented.

getAuctionHouseSearchRecordTypes

TypeList getAuctionHouseSearchRecordTypes()

Gets the supported AuctionHouse search record types.

Returns:

a list containing the supported AuctionHouse search record types

Compliance:

mandatory - This method must be implemented.

supportsAuctionHouseSearchRecordType

boolean supportsAuctionHouseSearchRecordType(Type auctionHouseSearchRecordType)

Tests if the given AuctionHouse search record type is supported.

Parameters:

auctionHouseSearchRecordType - a Type indicating a AuctionHouse search record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - auctionHouseSearchRecordType is null

Compliance:

mandatory - This method must be implemented.