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

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

MethodcanAssignAuctionConstrainerEnablers
Description

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

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

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

Parametersosid.id.IdauctionHouseIdthe Id of the AuctionHouse
osid.id.IdauctionConstrainerEnablerIdthe Id of the AuctionConstrainerEnabler
Returnosid.id.IdListlist of assignable auction house Ids
ErrorsNULL_ARGUMENT auctionHouseId or auctionConstrainerEnablerId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignAuctionConstrainerEnablerToAuctionHouse
Description

Adds an existing AuctionConstrainerEnabler to an AuctionHouse.

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

Removes an AuctionConstrainerEnabler from an AuctionHouse.

Parametersosid.id.IdauctionConstrainerEnablerIdthe Id of the AuctionConstrainerEnabler
osid.id.IdauctionHouseIdthe Id of the AuctionHouse
ErrorsNOT_FOUND auctionConstrainerEnablerId or auctionHouseId not found or auctionConstrainerEnablerId already assigned to auctionHouseId
NULL_ARGUMENT auctionConstrainerEnablerId or auctionHouseId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodreassignAuctionConstrainerEnablerToAuctionHouse
Description

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

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