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

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

MethodcanAssignAuctions
Description

Tests if this user can alter auction/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. 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.
MethodcanAssignAuctionsToAuctionHouse
Description

Tests if this user can alter auction/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. 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 auction 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.
MethodgetAssignableAuctionHouseIdsForAuction
Description

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

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

Adds an existing Auction to an AuctionHouse.

Parametersosid.id.IdauctionIdthe Id of the Auction
osid.id.IdauctionHouseIdthe Id of the AuctionHouse
ErrorsALREADY_EXISTS auctionId is already assigned to auctionHouseId
NOT_FOUND auctionId or auctionHouseId not found
NULL_ARGUMENT auctionId or auctionHouseId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignAuctionFromAuctionHouse
Description

Removes an Auction from an AuctionHouse.

Parametersosid.id.IdauctionIdthe Id of the Auction
osid.id.IdauctionHouseIdthe Id of the AuctionHouse
ErrorsNOT_FOUND auctionId or auctionHouseId not found or auctionId not assigned to auctionHouseId
NULL_ARGUMENT auctionId or auctionHouseId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodreassignAuctionToAuctionHouse
Description

Moves an Auction from one AuctionHouse to another. Mappings to other AuctionHouses are unaffected.

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