Interface | osid.bidding.batch.BidBatchAdminSession | ||
---|---|---|---|
Implements | osid.bidding.BidAdminSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create a The Once a batch of For updates, Once a batch of The delete operations delete | ||
Method | getBidFormsForCreate | ||
Description |
Gets the bid forms for creating a bunch of new bids. A form is returned for each auction and bidder pair. | ||
Parameters | osid.bidding.batch.BidPeerList | peers | the relationship peers |
osid.type.Type[] | bidRecordTypes | array of bid record types to be included in each create operation or an empty list if none | |
Return | osid.bidding.batch.BidBatchFormList | the bid forms | |
Errors | NOT_FOUND | an auctionId or bidderId is not found | |
NULL_ARGUMENT | peers or bidRecordTypes is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to request forms with given record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createBids | ||
Description |
Creates a new set of | ||
Parameters | osid.bidding.batch.BidBatchFormList | bidForms | the bid forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | bidForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getBidFormsForUpdate | ||
Description |
Gets the bid forms for updating an existing set of bids. A new bid form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | bidIds | the Ids of the Bid |
Return | osid.bidding.batch.BidBatchFormList | the bid form | |
Errors | NOT_FOUND | a bidId is not found | |
NULL_ARGUMENT | bidIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateBids | ||
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 | ||
Parameters | osid.bidding.batch.BidBatchFormList | bidForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | bidForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllBids | ||
Description |
Deletes all | ||
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteBids | ||
Description |
Deletes bids for the given | ||
Parameters | osid.id.IdList | bidIds | the Ids of the bids to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | bidIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteBidsForAuction | ||
Description |
Deletes bids for the given auction. | ||
Parameters | osid.id.Id | auctionId | the Id of an auction |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | auctionId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteBidsForBidder | ||
Description |
Deletes bids for the given bidder. | ||
Parameters | osid.id.Id | resourceId | the Id of a resource |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | resourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteIneffectiveBidsByDate | ||
Description |
Deletes bids expired before the given date. | ||
Parameters | osid.calendaring.DateTime | date | a date |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | date is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | aliasBids | ||
Description |
Adds an | ||
Parameters | osid.transaction.batch.AliasRequestList | aliasRequests | the alias requests |
Return | osid.transaction.batch.AliasResponseList | the alias responses | |
Errors | NULL_ARGUMENT | aliasRequests is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |