OSID Logo
OSID Specifications
bidding batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.bidding.batch.BidBatchAdminSession
Implementsosid.bidding.BidAdminSession
Description

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

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

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

For updates, BidForms are requested to the Bid Id that is to be updated using getBidFormsForUpdate() where the reference Id in the BidForm may be used to link the request. Similarly, the BidForm has metadata about the data that can be updated and it can perform validation before submitting the update. The BidForm can only be used once for a successful update and cannot be reused.

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

The delete operations delete Bids in bulk. To unmap a Bid from the current AuctionHouse, the BidAuctionHouseAssignmentSession should be used. These delete operations attempt to remove the Bid itself thus removing it from all known AuctionHouse catalogs. Bulk delete operations return the results in DeleteResponses.

MethodgetBidFormsForCreate
Description

Gets the bid forms for creating a bunch of new bids. A form is returned for each auction and bidder pair.

Parametersosid.bidding.batch.BidPeerListpeersthe relationship peers
osid.type.Type[]bidRecordTypesarray of bid record types to be included in each create operation or an empty list if none
Returnosid.bidding.batch.BidBatchFormListthe bid forms
ErrorsNOT_FOUNDan auctionId or bidderId is not found
NULL_ARGUMENT peers or bidRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateBids
Description

Creates a new set of Bids. 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.BidBatchFormListbidFormsthe bid forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT bidForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBidFormsForUpdate
Description

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

Parametersosid.id.IdListbidIdsthe Ids of the Bid
Returnosid.bidding.batch.BidBatchFormListthe bid form
ErrorsNOT_FOUNDa bidId is not found
NULL_ARGUMENT bidIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateBids
Description

Updates existing bids. 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.BidBatchFormListbidFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT bidForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllBids
Description

Deletes all Bids in this AuctionHouse .

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

Deletes bids for the given Ids.

Parametersosid.id.IdListbidIdsthe Ids of the bids to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT bidIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteBidsForAuction
Description

Deletes bids for the given auction.

Parametersosid.id.IdauctionIdthe Id of an auction
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT auctionId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteBidsForBidder
Description

Deletes bids for the given bidder.

Parametersosid.id.IdresourceIdthe Id of a resource
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteIneffectiveBidsByDate
Description

Deletes bids expired before the given date.

Parametersosid.calendaring.DateTimedatea date
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT date is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasBids
Description

Adds an Id to a Bid for the purpose of creating compatibility. The primary Id of the Bid is determined by the provider. The new Id is an alias to the primary Id. If the alias is a pointer to another bid, 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.