OSID Logo
OSID Specifications
bidding rules package
Version 3.0.0
Interfaceosid.bidding.rules.BidEnablerAuctionHouseAssignmentSession
Implementsosid.OsidSession
Used Byosid.bidding.rules.BiddingRulesManager
osid.bidding.rules.BiddingRulesProxyManager
Description

This session provides methods to re-assign BidEnabler to AuctionHouse mappings. A BidEnabler may appear in multiple AuctionHouse catalogs and removing the last reference to a BidEnabler 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 BidEnabler to another AuctionHouse is not a copy operation (eg: does not change its Id ).

MethodcanAssignBidEnablers
Description

Tests if this user can alter bid enabler/auction house mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a PERMISSION_DENIED. T his is intended as a hint to an application that may opt not to offer assignment operations to unauthorized users.

Returnbooleanfalse if mapping is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanAssignBidEnablerToAuctionHouse
Description

Tests if this user can alter bid enabler/auction house mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a PERMISSION_DENIED. T his 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
Returnbooleanfalse if mapping is not authorized, true otherwise
ErrorsNULL_ARGUMENTauctionHouseId 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 enabler can be assigned.

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

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

Parametersosid.id.IdauctionHouseIdthe Id of the AuctionHouse
osid.id.IdbidEnablerIdthe Id of the BidEnabler
Returnosid.id.IdListlist of assignable auction house Ids
ErrorsNULL_ARGUMENTauctionHouseId or bidEnablerId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignBidEnablerToAuctionHouse
Description

Adds an existing BidEnabler to an AuctionHouse .

Parametersosid.id.IdbidEnablerIdthe Id of the BidEnabler
osid.id.IdauctionHouseIdthe Id of the AuctionHouse
ErrorsALREADY_EXISTSbidEnablerId is already assigned to auctionHouseId
NOT_FOUNDbidEnablerId or auctionHouseId not found
NULL_ARGUMENTbidEnablerId or auctionHouseId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignBidEnablerFromAuctionHouse
Description

Removes a BidEnabler from an AuctionHouse .

Parametersosid.id.IdbidEnablerIdthe Id of the BidEnabler
osid.id.IdauctionHouseIdthe Id of the AuctionHouse
ErrorsNOT_FOUNDbidEnablerId or auctionHouseId not found or bidEnablerId not assigned to auctionHouseId
NULL_ARGUMENTbidEnablerId or auctionHouseId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodreassignBidEnablerToAuctionHouse
Description

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

Parametersosid.id.IdbidEnablerIdthe Id of the BidEnabler
osid.id.IdfromAuctionHouseIdthe Id of the current AuctionHouse
osid.id.IdtoAuctionHouseIdthe Id of the destination AuctionHouse
ErrorsALREADY_EXISTSbidEnablerId already assigned to toAuctionHouseId
NOT_FOUNDbidEnablerId, fromAuctionHouseId , or toAuctionHouseId not found or bidEnablerId not mapped to fromAuctionHouseId
NULL_ARGUMENTbidEnablerId, fromAuctionHouseId , or toAuctionHouseId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.