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

This session provides methods to apply AuctionProcessorEnablers to AuctionProcessors. An AuctionProcessor with multiple AuctionProcessorEnablers means any positive rule evaluation across the enablers result in an effective AuctionProcessor.

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.
MethodcanAssignAuctionProcessorEnablers
Description

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

Adds an existing AuctionProcessorEnabler to an AuctionProcessor.

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

Removes an AuctionProcessorEnabler from an AuctionProcessor.

Parametersosid.id.IdauctionProcessorEnablerIdthe Id of the AuctionProcessorEnabler
osid.id.IdauctionProcessorIdthe Id of the AuctionProcessor
ErrorsNOT_FOUND auctionProcessorEnablerId or auctionProcessorId not found or not mapped
NULL_ARGUMENT auctionProcessorEnablerId or auctionProcessorId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSequenceAuctionProcessorEnablers
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 AuctionProcessorEnabler ordering is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodmoveAuctionProcessorEnablerAhead
Description

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

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

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

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

Reorders a set of auction processor enablers for an auction processor.

Parametersosid.id.Id[]auctionProcessorEnablerIdsthe Ids for a set of AuctionProcessorEnablers
osid.id.IdauctionProcessorIdthe Id of an AuctionProcessor
ErrorsNOT_FOUND auctionProcessorId not found or, an auctionProcessorEnablerId not related to auctionProcessorId
NULL_ARGUMENT auctionProcessorEnablerIds or auctionProcessorId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.