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

This session creates, updates, and deletes Auctions. 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 Auction, an AuctionForm is requested using getAuctionFormForCreate() specifying the desired record Types or none if no record Types are needed. The returned AuctionForm 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 AuctionForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each AuctionForm corresponds to an attempted transaction.

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

The delete operations delete Auctions. To unmap an Auction from the current AuctionHouse, the AuctionAuctionHouseAssignmentSession should be used. These delete operations attempt to remove the Auction itself thus removing it from all known AuctionHouse catalogs.

This session includes an Id aliasing mechanism to assign an external Id to an internally assigned Id.

MethodgetAuctionHouseId
Description

Gets the AuctionHouse Id associated with this session.

Returnosid.id.Idthe AuctionHouse Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetAuctionHouse
Description

Gets the AuctionHouse associated with this session.

Returnosid.bidding.AuctionHousethe auction house
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanCreateAuctions
Description

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

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

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

Parametersosid.type.Type[]auctionRecordTypesarray of auction record types
Returnboolean true if Auction creation using the specified record Types is supported, false otherwise
ErrorsNULL_ARGUMENT auctionRecordTypes is null
CompliancemandatoryThis method must be implemented.
MethodgetAuctionFormForCreate
Description

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

Parametersosid.type.Type[]auctionRecordTypesarray of auction record types
Returnosid.bidding.AuctionFormthe auction form
ErrorsNULL_ARGUMENT auctionRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to get form for requested record types
CompliancemandatoryThis method must be implemented.
MethodcreateAuction
Description

Creates a new Auction.

Parametersosid.bidding.AuctionFormauctionFormthe form for this Auction
Returnosid.bidding.Auctionthe new Auction
ErrorsILLEGAL_STATE auctionForm already used in a create transaction
INVALID_ARGUMENTone or more of the form elements is invalid
NULL_ARGUMENT auctionForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED auctionForm did not originate from getAuctionFormForCreate()
CompliancemandatoryThis method must be implemented.
MethodcanUpdateAuctions
Description

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

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

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

Parametersosid.id.IdauctionIdthe Id of the Auction
Returnosid.bidding.AuctionFormthe auction form
ErrorsNOT_FOUND auctionId is not found
NULL_ARGUMENT auctionId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateAuction
Description

Updates an existing auction.

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

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

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

Deletes an Auction.

Parametersosid.id.IdauctionIdthe Id of the Auction to remove
ErrorsNOT_FOUND auctionId not found
NULL_ARGUMENT auctionId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageAuctionAliases
Description

Tests if this user can manage Id aliases for Auctions. 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 Auction aliasing is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodaliasAuction
Description

Adds an Id to an Auction for the purpose of creating compatibility. The primary Id of the Auction is determined by the provider. The new Id performs as an alias to the primary Id. If the alias is a pointer to another auction, it is reassigned to the given auction Id.

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