OSID - osid.bidding.BiddingProfile Service Interface Definition

Interface	osid.bidding.BiddingProfile
Implements	`osid.OsidProfile`
Implemented By	`osid.bidding.BiddingManager`
Implemented By	`osid.bidding.BiddingProxyManager`
Description	The bidding profile describes the interoperability among bidding services.
Method	supportsVisibleFederation
Description	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.
Return	`boolean`		`true` if visible federation is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsMyAuction
Description	Tests if a my auction service is supported for the current agent.
Return	`boolean`		`true` if my auction is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsMyAuctionNotification
Description	Tests if a my auction notification service is supported for the current agent.
Return	`boolean`		`true` if my auction notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAuctionLookup
Description	Tests if looking up auctions is supported.
Return	`boolean`		`true` if auction lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAuctionQuery
Description	Tests if querying auctions is supported.
Return	`boolean`		`true` if auction query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAuctionSearch
Description	Tests if searching auctions is supported.
Return	`boolean`		`true` if auction search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAuctionAdmin
Description	Tests if an auction administrative service is supported.
Return	`boolean`		`true` if auction administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAuctionNotification
Description	Tests if an auction notification service is supported.
Return	`boolean`		`true` if auction notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAuctionAuctionHouse
Description	Tests if an auction auction house lookup service is supported.
Return	`boolean`		`true` if an auction auction house lookup service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAuctionAuctionHouseAssignment
Description	Tests if an auction auction house assignment service is supported.
Return	`boolean`		`true` if an auction to auction house assignment service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAuctionSmartAuctionHouse
Description	Tests if an auction smart auction house service is supported.
Return	`boolean`		`true` if a smart auction house service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsBidLookup
Description	Tests if looking up bids is supported.
Return	`boolean`		`true` if bid lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsBidQuery
Description	Tests if querying bids is supported.
Return	`boolean`		`true` if bid query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsBidSearch
Description	Tests if searching bids is supported.
Return	`boolean`		`true` if bid search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsBidAdmin
Description	Tests if bid administrative service is supported.
Return	`boolean`		`true` if bid administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsBidNotification
Description	Tests if a bid notification service is supported.
Return	`boolean`		`true` if bid notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsBidAuctionHouse
Description	Tests if a bid auction house lookup service is supported.
Return	`boolean`		`true` if a bid auction house lookup service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsBidAuctionHouseAssignment
Description	Tests if a bid auction house service is supported.
Return	`boolean`		`true` if bid to auction house assignment service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsBidSmartAuctionHouse
Description	Tests if a bid smart auction house lookup service is supported.
Return	`boolean`		`true` if a bid smart auction house service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAuctionHouseLookup
Description	Tests if looking up auction houses is supported.
Return	`boolean`		`true` if auction house lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAuctionHouseQuery
Description	Tests if querying auction houses is supported.
Return	`boolean`		`true` if an auction house query service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAuctionHouseSearch
Description	Tests if searching auction houses is supported.
Return	`boolean`		`true` if auction house search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAuctionHouseAdmin
Description	Tests if auction house administrative service is supported.
Return	`boolean`		`true` if auction house administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAuctionHouseNotification
Description	Tests if an auction house notification service is supported.
Return	`boolean`		`true` if auction house notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAuctionHouseHierarchy
Description	Tests for the availability of an auction house hierarchy traversal service.
Return	`boolean`		`true` if auction house hierarchy traversal is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented in all providers.
Method	supportsAuctionHouseHierarchyDesign
Description	Tests for the availability of an auction house hierarchy design service.
Return	`boolean`		`true` if auction house hierarchy design is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsBiddingBatch
Description	Tests for the availability of a bidding batch service.
Return	`boolean`		`true` if a bidding batch service is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsBiddingRules
Description	Tests for the availability of a bidding rules service.
Return	`boolean`		`true` ifa bidding rules service is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAuctionRecordTypes
Description	Gets the supported `Auction` record types.
Return	`osid.type.TypeList`		a list containing the supported `Auction` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsAuctionRecordType
Description	Tests if the given `Auction` record type is supported.
Parameters	`osid.type.Type`	`auctionRecordType`	a `Type` indicating an `Auction` record type
Return	`boolean`		`true` if the given record type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`auctionRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getAuctionSearchRecordTypes
Description	Gets the supported `Auction` search types.
Return	`osid.type.TypeList`		a list containing the supported `Auction` search types
Compliance	`mandatory`		This method must be implemented.
Method	supportsAuctionSearchRecordType
Description	Tests if the given `Auction` search type is supported.
Parameters	`osid.type.Type`	`auctionSearchRecordType`	a `Type` indicating an `Auction` search type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`auctionSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getBidRecordTypes
Description	Gets the supported `Bid` record types.
Return	`osid.type.TypeList`		a list containing the supported `Bid` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsBidRecordType
Description	Tests if the given `Bid` record type is supported.
Parameters	`osid.type.Type`	`bidRecordType`	a `Type` indicating a `Bid` record type
Return	`boolean`		`true` if the given record type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`bidRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getBidSearchRecordTypes
Description	Gets the supported `Bid` search record types.
Return	`osid.type.TypeList`		a list containing the supported `Bid` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsBidSearchRecordType
Description	Tests if the given `Bid` search record type is supported.
Parameters	`osid.type.Type`	`bidSearchRecordType`	a `Type` indicating a `Bid` search record type
Return	`boolean`		`true` if the given search record type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`bidSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getAuctionHouseRecordTypes
Description	Gets the supported `AuctionHouse` record types.
Return	`osid.type.TypeList`		a list containing the supported `AuctionHouse` types
Compliance	`mandatory`		This method must be implemented.
Method	supportsAuctionHouseRecordType
Description	Tests if the given `AuctionHouse` record type is supported.
Parameters	`osid.type.Type`	`auctionHouseRecordType`	a `Type` indicating an `AuctionHouse` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`auctionHouseRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getAuctionHouseSearchRecordTypes
Description	Gets the supported `AuctionHouse` search record types.
Return	`osid.type.TypeList`		a list containing the supported `AuctionHouse` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsAuctionHouseSearchRecordType
Description	Tests if the given `AuctionHouse` search record type is supported.
Parameters	`osid.type.Type`	`auctionHouseSearchRecordType`	a `Type` indicating an `AuctionHouse` search record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`auctionHouseSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.