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

This session creates, updates, and deletes Auctions in bulk. 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 getAuctionFormsForCreate() specifying the desired record Types or none if no record Types are needed. Each of the returned AuctionForms 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 an 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.

The AuctionForms returned from getAuctionFormsForCreate() may be linked to the originating request through the peer Ids of the AuctionForm. In the case where there may be duplicates, any AuctionForm of the same peer Ids may be used for a create operation.

Once a batch of AuctionForms are submitted for create, a CreateResponse is returned for each AuctionForm, although the ordering is not defined. Only errors that pertain to the entire create operation are returned from createAuctions(), errors specific to an individual AuctionForm are indicated in the corresponding CreateResponse. CreateResponses may be linked to the originating AuctionForm through the AuctionForm Id .

For updates, AuctionForms are requested to the Auction Id that is to be updated using getAuctionFormsForUpdate() where the reference Id in the AuctionForm may be used to link the request. 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.

Once a batch of AuctionForms are submitted for update, an UpdateResponse is returned for each AuctionForm, although the ordering is not defined. Only errors that pertain to the entire update operation are returned from updateAuctions(), errors specific to an individual AuctionForm are indicated in the corresponding UpdateResponse. UpdateResponses may be linked to the originating AuctionForm through the AuctionForm Id.

The delete operations delete Auctions in bulk. 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. Bulk delete operations return the results in DeleteResponses.

MethodgetAuctionFormsForCreate
Description

Gets the auction forms for creating a bunch of new auctions.

Parameterscardinalnumberthe number of foms to retrieve
osid.type.Type[]auctionRecordTypesarray of auction record types to be included in each create operation or an empty list if none
Returnosid.bidding.batch.AuctionBatchFormListthe auction forms
ErrorsNULL_ARGUMENT auctionRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateAuctions
Description

Creates a new set of Auctions. This method returns an error if the entire operation fails. Otherwise, the status of an individual create operation is indicated in the BatchCreateResponse .

Parametersosid.bidding.batch.AuctionBatchFormListauctionFormsthe auction forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT auctionForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAuctionFormsForUpdate
Description

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

Parametersosid.id.IdListauctionIdsthe Ids of the Auction
Returnosid.bidding.batch.AuctionBatchFormListthe auction form
ErrorsNOT_FOUNDan auctionId is not found
NULL_ARGUMENT auctionIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateAuctions
Description

Updates existing auctions. This method returns an error if the entire operation fails. Otherwise, the status of an individual update operation is indicated in the BatchCreateResponse .

Parametersosid.bidding.batch.AuctionBatchFormListauctionFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT auctionForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllAuctions
Description

Deletes all Auctions in this AuctionHouse .

Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAuctions
Description

Deletes auctions for the given Ids.

Parametersosid.id.IdListauctionIdsthe Ids of the auctions to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT auctionIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasAuctions
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 is an alias to the primary Id. If the alias is a pointer to another auction, it is reassigned to the given entry Id.

Parametersosid.transaction.batch.AliasRequestListaliasRequeststhe alias requests
Returnosid.transaction.batch.AliasResponseListthe alias responses
ErrorsNULL_ARGUMENT aliasRequests is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.