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

This session creates, updates, and deletes AuctionHouses. The data for create and update is provided by the consumer via the form object. OsidForms are requested for each create or update and may not be reused.

Create and update operations differ in their usage. To create an AuctionHouse, an AuctionHouseForm is requested using getAuctionHouseFormForCreate() specifying the desired record Types or none if no record Types are needed. The returned AuctionHouseForm will indicate that it is to be used with a create operation and can be used to examine metdata or validate data prior to creation. Once the AuctionHouseForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each AuctionHouseForm corresponds to an attempted transaction.

For updates, AuctionHouseForms are requested to the AuctionHouse Id that is to be updated using getAuctionHouseFormForUpdate(). Similarly, the AuctionHouseForm has metadata about the data that can be updated and it can perform validation before submitting the update. The AuctionHouseForm can only be used once for a successful update and cannot be reused.

The delete operations delete AuctionHouses. This session includes an Id aliasing mechanism to assign an external Id to an internally assigned Id.

MethodcanCreateAuctionHouses
Description

Tests if this user can create AuctionHouses. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating an AuctionHouse. will result in a PERMISSION_DENIED. This is intended as a hint to an application that may not wish to offer create operations to unauthorized users.

Returnboolean false if AuctionHouse creation is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanCreateAuctionHouseWithRecordTypes
Description

Tests if this user can create a single AuctionHouse using the desired record types. While BiddingManager.getAuctionHouseRecordTypes() can be used to examine which records are supported, this method tests which record(s) are required for creating a specific AuctionHouse. Providing an empty array tests if an AuctionHouse can be created with no records.

Parametersosid.type.Type[]auctionHouseRecordTypesarray of auction house record types
Returnboolean true if AuctionHouse creation using the specified record Types is supported, false otherwise
ErrorsNULL_ARGUMENT auctionHouseRecordTypes is null
CompliancemandatoryThis method must be implemented.
MethodgetAuctionHouseFormForCreate
Description

Gets the auction house form for creating new auction houses. A new form should be requested for each create transaction.

Parametersosid.type.Type[]auctionHouseRecordTypesarray of auction house record types
Returnosid.bidding.AuctionHouseFormthe auction house form
ErrorsNULL_ARGUMENT auctionHouseRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to get form for requested record types
CompliancemandatoryThis method must be implemented.
MethodcreateAuctionHouse
Description

Creates a new AuctionHouse.

Parametersosid.bidding.AuctionHouseFormauctionHouseFormthe form for this AuctionHouse
Returnosid.bidding.AuctionHousethe new AuctionHouse
ErrorsILLEGAL_STATE auctionHouseForm already used in a create transaction
INVALID_ARGUMENTone or more of the form elements is invalid
NULL_ARGUMENT auctionHouseForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED auctionHouseForm did not originate from getAuctionHouseFormForCreate()
CompliancemandatoryThis method must be implemented.
MethodcanUpdateAuctionHouses
Description

Tests if this user can update Auction Houses. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating an AuctionHouse will result in a PERMISSION_DENIED. This is intended as a hint to an application that may not wish to offer update operations to unauthorized users.

Returnboolean false if AuctionHouse modification is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetAuctionHouseFormForUpdate
Description

Gets the auction house form for updating an existing auction house. A new auction house form should be requested for each update transaction.

Parametersosid.id.IdauctionHouseIdthe Id of the AuctionHouse
Returnosid.bidding.AuctionHouseFormthe auction house form
ErrorsNOT_FOUND auctionHouseId is not found
NULL_ARGUMENT auctionHouseId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateAuctionHouse
Description

Updates an existing auction house

Parametersosid.bidding.AuctionHouseFormauctionHouseFormthe form containing the elements to be updated
ErrorsILLEGAL_STATE auctionHouseForm already used in an update transaction
INVALID_ARGUMENTthe form contains an invalid value
NULL_ARGUMENT auctionHouseForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED auctionHouseForm did not originate from getAuctionHouseFormForUpdate()
CompliancemandatoryThis method must be implemented.
MethodcanDeleteAuctionHouses
Description

Tests if this user can delete AuctionHouses. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an AuctionHouse will result in a PERMISSION_DENIED. This is intended as a hint to an application that may not wish to offer delete operations to unauthorized users.

Returnboolean false if AuctionHouse deletion is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoddeleteAuctionHouse
Description

Deletes an AuctionHouse.

Parametersosid.id.IdauctionHouseIdthe Id of the AuctionHouse to remove
ErrorsNOT_FOUND auctionHouseId not found
NULL_ARGUMENT auctionHouseId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageAuctionHouseAliases
Description

Tests if this user can manage Id aliases for Auction Houses. A return of true does not guarantee successful authorization. A return of false indicates that it is known changing an alias will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer alias operations to an unauthorized user.

Returnboolean false if AuctionHouse aliasing is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodaliasAuctionHouse
Description

Adds an Id to an AuctionHouse for the purpose of creating compatibility. The primary Id of the AuctionHouse is determined by the provider. The new Id performs as an alias to the primary Id.

Parametersosid.id.IdauctionHouseIdthe Id of an AuctionHouse
osid.id.IdaliasIdthe alias Id
ErrorsALREADY_EXISTS aliasId is already assigned
NOT_FOUND auctionHouseId not found
NULL_ARGUMENT auctionHouseId or aliasId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.