org.osid.bidding.batch

Interface AuctionBatchAdminSession

All Superinterfaces:

AuctionAdminSession, java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface AuctionBatchAdminSession
extends AuctionAdminSession

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.

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasAuctions(AliasRequestList aliasRequests) Adds an Id to an Auction for the purpose of creating compatibility.
CreateResponseList	createAuctions(AuctionBatchFormList auctionForms) Creates a new set of Auctions.
DeleteResponseList	deleteAllAuctions() Deletes all Auctions in this AuctionHouse .
DeleteResponseList	deleteAuctions(IdList auctionIds) Deletes auctions for the given Ids.
AuctionBatchFormList	getAuctionFormsForCreate(long number, Type[] auctionRecordTypes) Gets the auction forms for creating a bunch of new auctions.
AuctionBatchFormList	getAuctionFormsForUpdate(IdList auctionIds) Gets the auction forms for updating an existing set of auctions.
UpdateResponseList	updateAuctions(AuctionBatchFormList auctionForms) Updates existing auctions.

Methods inherited from interface org.osid.bidding.AuctionAdminSession

aliasAuction, canCreateAuctions, canCreateAuctionWithRecordTypes, canDeleteAuctions, canManageAuctionAliases, canUpdateAuctions, createAuction, deleteAuction, getAuctionFormForCreate, getAuctionFormForUpdate, getAuctionHouse, getAuctionHouseId, updateAuction

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getAuctionFormsForCreate

AuctionBatchFormList getAuctionFormsForCreate(long number,
                                            Type[] auctionRecordTypes)
                                              throws OperationFailedException,
                                                     PermissionDeniedException

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

Parameters:

number - the number of foms to retrieve

auctionRecordTypes - array of auction record types to be included in each create operation or an empty list if none

Returns:

the auction forms

Throws:

NullArgumentException - auctionRecordTypes is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - unable to request forms with given record types

Compliance:

mandatory - This method must be implemented.

createAuctions

CreateResponseList createAuctions(AuctionBatchFormList auctionForms)
                                  throws OperationFailedException,
                                         PermissionDeniedException

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 .

Parameters:

auctionForms - the auction forms

Returns:

the create responses

Throws:

NullArgumentException - auctionForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAuctionFormsForUpdate

AuctionBatchFormList getAuctionFormsForUpdate(IdList auctionIds)
                                              throws NotFoundException,
                                                     OperationFailedException,
                                                     PermissionDeniedException

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

Parameters:

auctionIds - the Ids of the Auction

Returns:

the auction form

Throws:

NotFoundException - an auctionId is not found

NullArgumentException - auctionIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateAuctions

UpdateResponseList updateAuctions(AuctionBatchFormList auctionForms)
                                  throws OperationFailedException,
                                         PermissionDeniedException

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 .

Parameters:

auctionForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - auctionForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllAuctions

DeleteResponseList deleteAllAuctions()
                                     throws OperationFailedException,
                                            PermissionDeniedException

Deletes all Auctions in this AuctionHouse .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAuctions

DeleteResponseList deleteAuctions(IdList auctionIds)
                                  throws OperationFailedException,
                                         PermissionDeniedException

Deletes auctions for the given Ids.

Parameters:

auctionIds - the Ids of the auctions to delete

Returns:

the delete responses

Throws:

NullArgumentException - auctionIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasAuctions

AliasResponseList aliasAuctions(AliasRequestList aliasRequests)
                                throws OperationFailedException,
                                       PermissionDeniedException

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.

Parameters:

aliasRequests - the alias requests

Returns:

the alias responses

Throws:

NullArgumentException - aliasRequests is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.