public interface BidBatchAdminSession extends BidAdminSession
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.
Modifier and Type | Method and Description |
---|---|
AliasResponseList |
aliasBids(AliasRequestList aliasRequests)
Adds an
Id to a Bid for the purpose of
creating compatibility. |
CreateResponseList |
createBids(BidBatchFormList bidForms)
Creates a new set of
Bids. |
DeleteResponseList |
deleteAllBids()
Deletes all
Bids in this AuctionHouse . |
DeleteResponseList |
deleteBids(IdList bidIds)
Deletes bids for the given
Ids. |
DeleteResponseList |
deleteBidsForAuction(Id auctionId)
Deletes bids for the given auction.
|
DeleteResponseList |
deleteBidsForBidder(Id resourceId)
Deletes bids for the given bidder.
|
DeleteResponseList |
deleteIneffectiveBidsByDate(DateTime date)
Deletes bids expired before the given date.
|
BidBatchFormList |
getBidFormsForCreate(BidPeerList peers,
Type[] bidRecordTypes)
Gets the bid forms for creating a bunch of new bids.
|
BidBatchFormList |
getBidFormsForUpdate(IdList bidIds)
Gets the bid forms for updating an existing set of bids.
|
UpdateResponseList |
updateBids(BidBatchFormList bidForms)
Updates existing bids.
|
aliasBid, canCreateBids, canCreateBidWithRecordTypes, canDeleteBids, canManageBidAliases, canUpdateBids, createBid, deleteBid, getAuctionHouse, getAuctionHouseId, getBidFormForCreate, getBidFormForUpdate, updateBid
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
BidBatchFormList getBidFormsForCreate(BidPeerList peers, Type[] bidRecordTypes) throws NotFoundException, OperationFailedException, PermissionDeniedException
peers
- the relationship peersbidRecordTypes
- array of bid record types to be included in
each create operation or an empty list if noneNotFoundException
- an auctionId
or
bidderId
is not foundNullArgumentException
- peers
or
bidRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to request forms with
given record typesmandatory
- This method must be implemented. CreateResponseList createBids(BidBatchFormList bidForms) throws OperationFailedException, PermissionDeniedException
Bids.
This method returns an error
if the entire operation fails. Otherwise, the status of an individual
create operation is indicated in the BatchCreateResponse
.bidForms
- the bid formsNullArgumentException
- bidForms
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. BidBatchFormList getBidFormsForUpdate(IdList bidIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
bidIds
- the Ids
of the Bid
NotFoundException
- a bidId
is not foundNullArgumentException
- bidIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. UpdateResponseList updateBids(BidBatchFormList bidForms) throws OperationFailedException, PermissionDeniedException
BatchCreateResponse
.bidForms
- the form containing the elements to be updatedNullArgumentException
- bidForms
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAllBids() throws OperationFailedException, PermissionDeniedException
Bids
in this AuctionHouse
.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteBids(IdList bidIds) throws OperationFailedException, PermissionDeniedException
Ids.
bidIds
- the Ids
of the bids to deleteNullArgumentException
- bidIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteBidsForAuction(Id auctionId) throws OperationFailedException, PermissionDeniedException
auctionId
- the Id
of an auctionNullArgumentException
- auctionId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteBidsForBidder(Id resourceId) throws OperationFailedException, PermissionDeniedException
resourceId
- the Id
of a resourceNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteIneffectiveBidsByDate(DateTime date) throws OperationFailedException, PermissionDeniedException
date
- a dateNullArgumentException
- date
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AliasResponseList aliasBids(AliasRequestList aliasRequests) throws OperationFailedException, PermissionDeniedException
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.
aliasRequests
- the alias requestsNullArgumentException
- aliasRequests
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.