OSID Logo
OSID Specifications
financials batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.financials.batch.BusinessBatchAdminSession
Implementsosid.financials.BusinessAdminSession
Description

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.

MethodgetBusinessFormsForCreate
Description

Gets the business forms for creating a bunch of new businesses.

Parameterscardinalnumberthe number of forms to retrieve
osid.type.Type[]businessRecordTypesarray of business record types to be included in each create operation or an empty list if none
Returnosid.financials.batch.BusinessBatchFormListthe business forms
ErrorsNULL_ARGUMENT businessRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateBusinesses
Description

Creates a new set of Businesses. This method returns an error if the entire operation fails. Otherwise, the status of an individual create operation is indicated in the BatchCreateResponse .

Parametersosid.financials.batch.BusinessBatchFormListbusinessFormsthe business forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT businessForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBusinessFormsForUpdate
Description

Gets the business forms for updating an existing set of businesses. A new business form should be requested for each update transaction.

Parametersosid.id.IdListbusinessIdsthe Ids of the Business
Returnosid.financials.batch.BusinessBatchFormListthe business form
ErrorsNOT_FOUNDa businessId is not found
NULL_ARGUMENT businessIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateBusinesses
Description

Updates existing businesses. This method returns an error if the entire operation fails. Otherwise, the status of an individual update operation is indicated in the BatchCreateResponse .

Parametersosid.financials.batch.BusinessBatchFormListbusinessFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT businessForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllBusinesses
Description

Deletes all Businesses in this Business .

Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteBusinesses
Description

Deletes businesses for the given Ids.

Parametersosid.id.IdListbusinessIdsthe Ids of the businesses to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT businessIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasBusinesses
Description

Adds an 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.

Parametersosid.transaction.batch.AliasRequestListaliasRequeststhe alias requests
Returnosid.transaction.batch.AliasResponseListthe alias responses
ErrorsNULL_ARGUMENT aliasRequests is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.