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

This session creates, updates, and deletes AuctionHouses 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 AuctionHouse, an AuctionHouseForm is requested using getAuctionHouseFormsForCreate() specifying the desired record Types or none if no record Types are needed. Each of the returned AuctionHouseForms 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 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.

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

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

For updates, AuctionHouseForms are requested to the AuctionHouse Id that is to be updated using getAuctionHouseFormsForUpdate() where the reference Id in the AuctionHouseForm may be used to link the request. 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.

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

The delete operations delete AuctionHouses in bulk. Bulk delete operations return the results in DeleteResponses.

MethodgetAuctionHouseFormsForCreate
Description

Gets the auction house forms for creating a bunch of new auction houses.

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

Creates a new set of AuctionHouses. 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.AuctionHouseBatchFormListauctionHouseFormsthe auction house forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT auctionHouseForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAuctionHouseFormsForUpdate
Description

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

Parametersosid.id.IdListauctionHouseIdsthe Ids of the AuctionHouse
Returnosid.bidding.batch.AuctionHouseBatchFormListthe auction house form
ErrorsNOT_FOUNDan auctionHouseId is not found
NULL_ARGUMENT auctionHouseIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateAuctionHouses
Description

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

Deletes all AuctionHouses.

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

Deletes auction houses for the given Ids.

Parametersosid.id.IdListauctionHouseIdsthe Ids of the auction houses to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT auctionHouseIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasAuctionHouses
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 is an alias to the primary Id. If the alias is a pointer to another auction house, 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.