public interface BusinessBatchAdminSession extends BusinessAdminSession
This session creates, updates, and deletes Businesses
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
Business,
a BusinessForm
is requested using
getBusinessFormsForCreate()
specifying the desired record
Types
or none if no record Types
are needed. Each
of the returned BusinessForms
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 BusinessForm
is
submiited to a create operation, it cannot be reused with another create
operation unless the first operation was unsuccessful. Each
BusinessForm
corresponds to an attempted transaction.
The BusinessForms
returned from
getBusinessFormsForCreate()
may be linked to the originating
request through the peer Ids
of the BusinessForm.
In the case where there may be duplicates, any BusinessForm
of the same peer Ids
may be used for a create
operation.
Once a batch of BusinessForms
are submitted for create,
a CreateResponse
is returned for each BusinessForm,
although the ordering is not defined. Only errors that pertain to
the entire create operation are returned from createBusinesses(),
errors specific to an individual BusinessForm
are
indicated in the corresponding CreateResponse.
CreateResponses
may be linked to the originating
BusinessForm
through the BusinessForm
Id
.
For updates, BusinessForms
are requested to the
Business
Id
that is to be updated using
getBusinessFormsForUpdate()
where the reference Id
in the BusinessForm
may be used to link the request.
Similarly, the BusinessForm
has metadata about the data
that can be updated and it can perform validation before submitting the
update. The BusinessForm
can only be used once for a
successful update and cannot be reused.
Once a batch of BusinessForms
are submitted for update,
an UpdateResponse
is returned for each BusinessForm,
although the ordering is not defined. Only errors that pertain to
the entire update operation are returned from updateBusinesses(),
errors specific to an individual BusinessForm
are
indicated in the corresponding UpdateResponse.
UpdateResponses
may be linked to the originating
BusinessForm
through the BusinessForm
Id.
The delete operations delete Businesses
in bulk. To
unmap a Business
from the current Business,
the BusinessBusinessAssignmentSession
should be used. These
delete operations attempt to remove the Business
itself
thus removing it from all known Business
catalogs. Bulk
delete operations return the results in DeleteResponses.
Modifier and Type | Method and Description |
---|---|
AliasResponseList |
aliasBusinesses(AliasRequestList aliasRequests)
Adds an
Id to a Business for the purpose
of creating compatibility. |
CreateResponseList |
createBusinesses(BusinessBatchFormList businessForms)
Creates a new set of
Businesses. |
DeleteResponseList |
deleteAllBusinesses()
Deletes all
Businesses in this Business
. |
DeleteResponseList |
deleteBusinesses(IdList businessIds)
Deletes businesses for the given
Ids. |
BusinessBatchFormList |
getBusinessFormsForCreate(long number,
Type[] businessRecordTypes)
Gets the business forms for creating a bunch of new businesses.
|
BusinessBatchFormList |
getBusinessFormsForUpdate(IdList businessIds)
Gets the business forms for updating an existing set of businesses.
|
UpdateResponseList |
updateBusinesses(BusinessBatchFormList businessForms)
Updates existing businesses.
|
aiiasBusiness, canCreateBusinesses, canCreateBusinessWithRecordTypes, canDeleteBusinesses, canManageBusinessAliases, canUpdateBusinesses, createBusiness, deleteBusiness, getBusinessFormForCreate, getBusinessFormForUpdate, updateBusiness
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
BusinessBatchFormList getBusinessFormsForCreate(long number, Type[] businessRecordTypes) throws OperationFailedException, PermissionDeniedException
number
- the number of forms to retrievebusinessRecordTypes
- array of business record types to be
included in each create operation or an empty list if noneNullArgumentException
- businessRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to request forms with
given record typesmandatory
- This method must be implemented. CreateResponseList createBusinesses(BusinessBatchFormList businessForms) throws OperationFailedException, PermissionDeniedException
Businesses.
This method returns an
error if the entire operation fails. Otherwise, the status of an
individual create operation is indicated in the
BatchCreateResponse
.businessForms
- the business formsNullArgumentException
- businessForms
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. BusinessBatchFormList getBusinessFormsForUpdate(IdList businessIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
businessIds
- the Ids
of the Business
NotFoundException
- a businessId
is not
foundNullArgumentException
- businessIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. UpdateResponseList updateBusinesses(BusinessBatchFormList businessForms) throws OperationFailedException, PermissionDeniedException
BatchCreateResponse
.businessForms
- the form containing the elements to be updatedNullArgumentException
- businessForms
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAllBusinesses() throws OperationFailedException, PermissionDeniedException
Businesses
in this Business
.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteBusinesses(IdList businessIds) throws OperationFailedException, PermissionDeniedException
Ids.
businessIds
- the Ids
of the businesses to deleteNullArgumentException
- businessIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AliasResponseList aliasBusinesses(AliasRequestList aliasRequests) throws OperationFailedException, PermissionDeniedException
Id
to a Business
for the purpose
of creating compatibility. The primary Id
of the
Business
is determined by the provider. The new Id
is an alias to the primary Id.
If the alias is
a pointer to another business, it is reassigned to the given business
Id.
aliasRequests
- the alias requestsNullArgumentException
- aliasRequests
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.