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

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

MethodcanAssignAuctionConstrainers
Description

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

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

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

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

Parametersosid.id.IdauctionHouseIdthe Id of the AuctionHouse
osid.id.IdauctionConstrainerIdthe Id of the AuctionConstrainer
Returnosid.id.IdListlist of assignable auction house Ids
ErrorsNULL_ARGUMENT auctionHouseId or auctionConstrainerId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignAuctionConstrainerToAuctionHouse
Description

Adds an existing AuctionConstrainer to an AuctionHouse.

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

Removes an AuctionConstrainer from an AuctionHouse.

Parametersosid.id.IdauctionConstrainerIdthe Id of the AuctionConstrainer
osid.id.IdauctionHouseIdthe Id of the AuctionHouse
ErrorsNOT_FOUND auctionConstrainerId or auctionHouseId not found or auctionConstrainerId already assigned to auctionHouseId
NULL_ARGUMENT auctionConstrainerId or auctionHouseId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodreassignAuctionConstrainerToAuctionHouse
Description

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

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