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

This session provides methods to apply AuctionProcessors to Auctions.

MethodgetAuctionHouseId
Description

Gets the AuctionHouse Id associated with this session.

Returnosid.id.Idthe AuctionHouse Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetAuctionHouse
Description

Gets the AuctionHouse associated with this session.

Returnosid.bidding.AuctionHousethe auction house
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanAssignAuctionProcessors
Description

Tests if this user can alter auction processor/auction 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 lookup operations to unauthorized users.

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

Adds an existing AuctionProcessor to an Auction.

Parametersosid.id.IdauctionProcessorIdthe Id of the AuctionProcessor
osid.id.IdauctionIdthe Id of the Auction
ErrorsALREADY_EXISTS auctionProcessorId already applied to auctionId
NOT_FOUND auctionProcessorId or auctionId not found
NULL_ARGUMENT auctionProcessorId or auctionId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignAuctionProcessorFromAuction
Description

Removes an AuctionProcessor from an Auction.

Parametersosid.id.IdauctionProcessorIdthe Id of the AuctionProcessor
osid.id.IdauctionIdthe Id of the Auction
ErrorsNOT_FOUND auctionProcessorId or auctionId not found or auctionProcessorId not applied to auctionId
NULL_ARGUMENT auctionProcessorId or auctionId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSequenceAuctionProcessors
Description

Tests if this user can order AuctionProcessors. A return of true does not guarantee successful authorization. A return of false indicates that it is known sequencing operations will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer sequencing operations to an unauthorized user.

Returnboolean false if AuctionProcessor ordering is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodmoveAuctionProcessorAhead
Description

Reorders auction processors for an auction by moving the specified auction processor in front of a reference auction processor.

Parametersosid.id.IdauctionProcessorIdthe Id of an AuctionProcessor
osid.id.IdauctionIdthe Id of an Auction
osid.id.IdreferenceIdthe reference auction processor Id
ErrorsNOT_FOUND auctionProcessorId, auctionId, or referenceId not found or, auctionProcessorId or referenceId not related to auctionId
NULL_ARGUMENT auctionProcessorId, auctionId, or referenceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodmoveAuctionProcessorBehind
Description

Reorders auction processors for an auction by moving the specified auction processor behind a reference auction processor.

Parametersosid.id.IdauctionProcessorIdthe Id of an AuctionProcessor
osid.id.IdauctionIdthe Id of an Auction
osid.id.IdreferenceIdthe reference auction processor Id
ErrorsNOT_FOUND auctionProcessorId, auctionId, or referenceId not found or, auctionProcessorId or referenceId not related to auctionId
NULL_ARGUMENT auctionProcessorId, auctionId, or referenceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodorderAuctionProcessors
Description

Reorders a set of auction processors for an auction.

Parametersosid.id.Id[]auctionProcessorIdsthe Ids for a set of AuctionProcessors
osid.id.IdauctionIdthe Id of an Auction
ErrorsNOT_FOUND auctionId not found or, an auctionProcessorId not related to auctionId
NULL_ARGUMENT auctionProcessorIds or auctionId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.