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

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

MethodcanAssignAuctionProcessors
Description

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

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

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

Parametersosid.id.IdauctionHouseIdthe Id of the AuctionHouse
osid.id.IdauctionProcessorIdthe Id of the AuctionProcessor
Returnosid.id.IdListlist of assignable auction house Ids
ErrorsNULL_ARGUMENT auctionHouseId or auctionProcessorId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignAuctionProcessorToAuctionHouse
Description

Adds an existing AuctionProcessor to an AuctionHouse.

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

Removes an AuctionProcessor from an AuctionHouse.

Parametersosid.id.IdauctionProcessorIdthe Id of the AuctionProcessor
osid.id.IdauctionHouseIdthe Id of the AuctionHouse
ErrorsNOT_FOUND auctionProcessorId or auctionHouseId not found or auctionProcessorId not assigned to auctionHouseId
NULL_ARGUMENT auctionProcessorId or auctionHouseId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodreassignAuctionProcessorToAuctionHouse
Description

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

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