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

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

MethodcanAssignAuctionProcessorEnablers
Description

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

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

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

Parametersosid.id.IdauctionHouseIdthe Id of the AuctionHouse
osid.id.IdauctionProcessorEnablerIdthe Id of the AuctionProcessorEnabler
Returnosid.id.IdListlist of assignable auction house Ids
ErrorsNULL_ARGUMENT auctionHouseId or auctionProcessorEnablerId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignAuctionProcessorEnablerToAuctionHouse
Description

Adds an existing AuctionProcessorEnabler to an AuctionHouse.

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

Removes an AuctionProcessorEnabler from an AuctionHouse.

Parametersosid.id.IdauctionProcessorEnablerIdthe Id of the AuctionProcessorEnabler
osid.id.IdauctionHouseIdthe Id of the AuctionHouse
ErrorsNOT_FOUND auctionProcessorEnablerId or auctionHouseId not found or auctionProcessorEnablerId not assigned to auctionHouseId
NULL_ARGUMENT auctionProcessorEnablerId or auctionHouseId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodreassignAuctionProcessorEnablerToAuctionHouse
Description

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

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