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

This session defines methods for managing a hierarchy of AuctionHouse objects. Each node in the hierarchy is a unique AuctionHouse.

MethodgetAuctionHouseHierarchyId
Description

Gets the hierarchy Id associated with this session.

Returnosid.id.Idthe hierarchy Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetAuctionHouseHierarchy
Description

Gets the hierarchy associated with this session.

Returnosid.hierarchy.Hierarchythe hierarchy associated with this session
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanModifyAuctionHouseHierarchy
Description

Tests if this user can change the hierarchy. A return of true does not guarantee successful authorization. A return of false indicates that it is known performing any update will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer these operations to an unauthorized user.

Returnboolean false if changing this hierarchy is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodaddRootAuctionHouse
Description

Adds a root auction house.

Parametersosid.id.IdauctionHouseIdthe Id of an auction house
ErrorsALREADY_EXISTS auctionHouseId is already in hierarchy
NOT_FOUND auctionHouseId not found
NULL_ARGUMENT auctionHouseId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveRootAuctionHouse
Description

Removes a root auction house.

Parametersosid.id.IdauctionHouseIdthe Id of an auction house
ErrorsNOT_FOUND auctionHouseId is not a root
NULL_ARGUMENT auctionHouseId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaddChildAuctionHouse
Description

Adds a child to an auction house.

Parametersosid.id.IdauctionHouseIdthe Id of an auction house
osid.id.IdchildIdthe Id of the new child
ErrorsALREADY_EXISTS auctionHouseId is already a parent of childId
NOT_FOUND auctionHouseId or childId not found
NULL_ARGUMENT auctionHouseId or childId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveChildAuctionHouse
Description

Removes a child from an auction house.

Parametersosid.id.IdauctionHouseIdthe Id of an auction house
osid.id.IdchildIdthe Id of the new child
ErrorsNOT_FOUND auctionHouseId is not parent of childId
NULL_ARGUMENT auctionHouseId or childId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveChildAuctionHouses
Description

Removes all children from an auction house.

Parametersosid.id.IdauctionHouseIdthe Id of an auction house
ErrorsNOT_FOUND auctionHouseId is not found
NULL_ARGUMENT auctionHouseId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.