org.osid.bidding.batch

Interface AuctionHouseBatchAdminSession

All Superinterfaces:

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

public interface AuctionHouseBatchAdminSession
extends AuctionHouseAdminSession

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.

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasAuctionHouses(AliasRequestList aliasRequests) Adds an Id to an AuctionHouse for the purpose of creating compatibility.
CreateResponseList	createAuctionHouses(AuctionHouseBatchFormList auctionHouseForms) Creates a new set of AuctionHouses.
DeleteResponseList	deleteAllAuctionHouses() Deletes all AuctionHouses.
DeleteResponseList	deleteAuctionHouses(IdList auctionHouseIds) Deletes auction houses for the given Ids.
AuctionHouseBatchFormList	getAuctionHouseFormsForCreate(long number, Type[] auctionHouseRecordTypes) Gets the auction house forms for creating a bunch of new auction houses.
AuctionHouseBatchFormList	getAuctionHouseFormsForUpdate(IdList auctionHouseIds) Gets the auction house forms for updating an existing set of auction houses.
UpdateResponseList	updateAuctionHouses(AuctionHouseBatchFormList auctionHouseForms) Updates existing auction houses.

Methods inherited from interface org.osid.bidding.AuctionHouseAdminSession

aliasAuctionHouse, canCreateAuctionHouses, canCreateAuctionHouseWithRecordTypes, canDeleteAuctionHouses, canManageAuctionHouseAliases, canUpdateAuctionHouses, createAuctionHouse, deleteAuctionHouse, getAuctionHouseFormForCreate, getAuctionHouseFormForUpdate, updateAuctionHouse

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

getAuctionHouseFormsForCreate

AuctionHouseBatchFormList getAuctionHouseFormsForCreate(long number,
                                                      Type[] auctionHouseRecordTypes)
                                                        throws OperationFailedException,
                                                               PermissionDeniedException

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

Parameters:

number - the number of forms to retrieve

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

Returns:

the auction house forms

Throws:

NullArgumentException - auctionHouseRecordTypes 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.

createAuctionHouses

CreateResponseList createAuctionHouses(AuctionHouseBatchFormList auctionHouseForms)
                                       throws OperationFailedException,
                                              PermissionDeniedException

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 .

Parameters:

auctionHouseForms - the auction house forms

Returns:

the create responses

Throws:

NullArgumentException - auctionHouseForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAuctionHouseFormsForUpdate

AuctionHouseBatchFormList getAuctionHouseFormsForUpdate(IdList auctionHouseIds)
                                                        throws NotFoundException,
                                                               OperationFailedException,
                                                               PermissionDeniedException

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.

Parameters:

auctionHouseIds - the Ids of the AuctionHouse

Returns:

the auction house form

Throws:

NotFoundException - an auctionHouseId is not found

NullArgumentException - auctionHouseIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateAuctionHouses

UpdateResponseList updateAuctionHouses(AuctionHouseBatchFormList auctionHouseForms)
                                       throws OperationFailedException,
                                              PermissionDeniedException

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 .

Parameters:

auctionHouseForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - auctionHouseForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllAuctionHouses

DeleteResponseList deleteAllAuctionHouses()
                                          throws OperationFailedException,
                                                 PermissionDeniedException

Deletes all AuctionHouses.

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAuctionHouses

DeleteResponseList deleteAuctionHouses(IdList auctionHouseIds)
                                       throws OperationFailedException,
                                              PermissionDeniedException

Deletes auction houses for the given Ids.

Parameters:

auctionHouseIds - the Ids of the auction houses to delete

Returns:

the delete responses

Throws:

NullArgumentException - auctionHouseIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasAuctionHouses

AliasResponseList aliasAuctionHouses(AliasRequestList aliasRequests)
                                     throws OperationFailedException,
                                            PermissionDeniedException

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.

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.