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

This session provides methods to apply AuctionConstrainerEnablers to AuctionConstrainers. An AuctionConstrainer with multiple AuctionConstrainerEnablers means any positive rule evaluation across the enablers result in an effective AuctionConstrainer.

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

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

Adds an existing AuctionConstrainerEnabler to an AuctionConstrainer.

Parametersosid.id.IdauctionConstrainerEnablerIdthe Id of the AuctionConstrainerEnabler
osid.id.IdauctionConstrainerIdthe Id of the AuctionConstrainer
ErrorsALREADY_EXISTS auctionConstrainerEnablerId already applied to auctionConstrainerId
NOT_FOUND auctionConstrainerEnablerId or auctionConstrainerId not found
NULL_ARGUMENT auctionConstrainerEnablerId or auctionConstrainerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignAuctionConstrainerEnablerFromAuctionConstrainer
Description

Removes an AuctionConstrainerEnabler from an AuctionConstrainer.

Parametersosid.id.IdauctionConstrainerEnablerIdthe Id of the AuctionConstrainerEnabler
osid.id.IdauctionConstrainerIdthe Id of the AuctionConstrainer
ErrorsNOT_FOUND auctionConstrainerEnablerId or auctionConstrainerId not found or auctionConstrainerEnablerId not applied to auctionConstrainerId
NULL_ARGUMENT auctionConstrainerEnablerId or auctionConstrainerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSequenceAuctionConstrainerEnablers
Description

Tests if this user can order AuctionConstrainerEnablers. 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 AuctionConstrainerEnabler ordering is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodmoveAuctionConstrainerEnablerAhead
Description

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

Parametersosid.id.IdauctionConstrainerEnablerIdthe Id of an AuctionConstrainerEnabler
osid.id.IdauctionConstrainerIdthe Id of an AuctionConstrainer
osid.id.IdreferenceIdthe reference auction constrainer enabler Id
ErrorsNOT_FOUND auctionConstrainerEnablerId, auctionConstrainerId, or referenceId not found or, auctionConstrainerEnablerId or referenceId not related to auctionConstrainerId
NULL_ARGUMENT auctionConstrainerEnablerId, auctionConstrainerId, or referenceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodmoveAuctionConstrainerEnablerBehind
Description

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

Parametersosid.id.IdauctionConstrainerEnablerIdthe Id of an AuctionConstrainerEnabler
osid.id.IdauctionConstrainerIdthe Id of an AuctionConstrainer
osid.id.IdreferenceIdthe reference auction constrainer enabler Id
ErrorsNOT_FOUND auctionConstrainerEnablerId, auctionConstrainerId, or referenceId not found or, auctionConstrainerEnablerId or referenceId not related to auctionConstrainerId
NULL_ARGUMENT auctionConstrainerEnablerId, auctionConstrainerId, or referenceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodorderAuctionConstrainerEnablers
Description

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

Parametersosid.id.Id[]auctionConstrainerEnablerIdsthe Ids for a set of AuctionConstrainerEnablers
osid.id.IdauctionConstrainerIdthe Id of an AuctionConstrainer
ErrorsNOT_FOUND auctionConstraienrId not found or, an auctionConstrainerEnablerId not related to auctionConstrainerId
NULL_ARGUMENT auctionConstrainerEnablerIds or auctionConstrainerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.