OSID Logo
OSID Specifications
bidding package
Version 3.0.0
Release Candidate Preview
Interfaceosid.bidding.BidAuctionHouseAssignmentSession
Implementsosid.OsidSession
Description

This session provides methods to re-assign Bids to AuctionHouse mappings. A Bid may appear in multiple AuctionHouse objects and removing the last reference to a Bid is the equivalent of deleting it. Each AuctionHouse may have its own authorizations governing who is allowed to operate on it.

Adding a reference of a Bid to another AuctionHouse is not a copy operation (eg: does not change its Id ).

MethodcanAssignBids
Description

Tests if this user can alter bid/auction house mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known item 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 assignment operations to unauthorized users.

Returnboolean false if mapping is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanAssignBidsToAuctionHouse
Description

Tests if this user can alter bid/auction house mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known item 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 assignment operations to unauthorized users.

Parametersosid.id.IdauctionHouseIdthe Id of the AuctionHouse
Returnboolean false if mapping is not authorized, true otherwise
ErrorsNULL_ARGUMENT auctionHouseId is null
CompliancemandatoryThis method must be implemented.
MethodgetAssignableAuctionHouseIds
Description

Gets a list of auction houses including and under the given auction house node in which any bid can be assigned.

Parametersosid.id.IdauctionHouseIdthe Id of the AuctionHouse
Returnosid.id.IdListlist of assignable auction house Ids
ErrorsNULL_ARGUMENT auctionHouseId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetAssignableAuctionHouseIdsForBid
Description

Gets a list of auction houses including and under the given auction house node in which a specific bid can be assigned.

Parametersosid.id.IdauctionHouseIdthe Id of the AuctionHouse
osid.id.IdbidIdthe Id of the Bid
Returnosid.id.IdListlist of assignable auction house Ids
ErrorsNULL_ARGUMENT auctionHouseId or bidId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignBidToAuctionHouse
Description

Adds an existing Bid to an AuctionHouse.

Parametersosid.id.IdbidIdthe Id of the Bid
osid.id.IdauctionHouseIdthe Id of the AuctionHouse
ErrorsALREADY_EXISTS bidId is already assigned tio auctionHouseId
NOT_FOUND bidId or auctionHouseId not found
NULL_ARGUMENT bidId or auctionHouseId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignBidFromAuctionHouse
Description

Removes a Bid from an AuctionHouse.

Parametersosid.id.IdbidIdthe Id of the Bid
osid.id.IdauctionHouseIdthe Id of the AuctionHouse
ErrorsNOT_FOUND bidId or auctionHouseId not found or bidId not assigned to auctionHouseId
NULL_ARGUMENT bidId or auctionHouseId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodreassignBidToAuctionHouse
Description

Moves a Bid from one AuctionHouse to another. Mappings to other AuctionHouses are unaffected.

Parametersosid.id.IdbidIdthe Id of the Bid
osid.id.IdfromAuctionHouseIdthe Id of the current AuctionHouse
osid.id.IdtoAuctionHouseIdthe Id of the destination AuctionHouse
ErrorsNOT_FOUND bidId, fromAuctionHouseId, or toAuctionHouseId not found or bidId not mapped to fromAuctionHouseId
NULL_ARGUMENT bidId, fromAuctionHouseId, or toAuctionHouseId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.