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.
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.
|
aliasAuctionHouse, canCreateAuctionHouses, canCreateAuctionHouseWithRecordTypes, canDeleteAuctionHouses, canManageAuctionHouseAliases, canUpdateAuctionHouses, createAuctionHouse, deleteAuctionHouse, getAuctionHouseFormForCreate, getAuctionHouseFormForUpdate, updateAuctionHouse
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
AuctionHouseBatchFormList getAuctionHouseFormsForCreate(long number, Type[] auctionHouseRecordTypes) throws OperationFailedException, PermissionDeniedException
number
- the number of forms to retrieveauctionHouseRecordTypes
- array of auction house record types to
be included in each create operation or an empty list if noneNullArgumentException
- auctionHouseRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to request forms with
given record typesmandatory
- This method must be implemented. CreateResponseList createAuctionHouses(AuctionHouseBatchFormList auctionHouseForms) throws OperationFailedException, PermissionDeniedException
AuctionHouses.
This method returns
an error if the entire operation fails. Otherwise, the status of an
individual create operation is indicated in the
BatchCreateResponse
.auctionHouseForms
- the auction house formsNullArgumentException
- auctionHouseForms
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AuctionHouseBatchFormList getAuctionHouseFormsForUpdate(IdList auctionHouseIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
auctionHouseIds
- the Ids
of the
AuctionHouse
NotFoundException
- an auctionHouseId
is
not foundNullArgumentException
- auctionHouseIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. UpdateResponseList updateAuctionHouses(AuctionHouseBatchFormList auctionHouseForms) throws OperationFailedException, PermissionDeniedException
BatchCreateResponse
.auctionHouseForms
- the form containing the elements to be
updatedNullArgumentException
- auctionHouseForms
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAllAuctionHouses() throws OperationFailedException, PermissionDeniedException
AuctionHouses.
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAuctionHouses(IdList auctionHouseIds) throws OperationFailedException, PermissionDeniedException
Ids.
auctionHouseIds
- the Ids
of the auction houses
to deleteNullArgumentException
- auctionHouseIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AliasResponseList aliasAuctionHouses(AliasRequestList aliasRequests) throws OperationFailedException, PermissionDeniedException
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.
aliasRequests
- the alias requestsNullArgumentException
- aliasRequests
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.