OSID Logo
OSID Specifications
billing batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.billing.batch.EntryBatchAdminSession
Implementsosid.billing.EntryAdminSession
Description

This session creates, updates, and deletes Entries 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 Entry, an EntryForm is requested using getEntryFormsForCreate() specifying the desired entry slot, period, record Types or none if no record Types are needed. Each of the returned EntryForms 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 EntryForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each EntryForm corresponds to an attempted transaction.

The EntryForms returned from getEntryFormsForCreate() may be linked to the originating request through the peer Ids of the EntryForm. In the case where there may be duplicates, any EntryForm of the same peer Ids may be used for a create operation.

Once a batch of EntryForms are submitted for create, a CreateResponse is returned for each EntryForm, although the ordering is not defined. Only errors that pertain to the entire create operation are returned from createEntries(), errors specific to an individual EntryForm are indicated in the corresponding CreateResponse. CreateResponses may be linked to the originating EntryForm through the EntryForm Id .

For updates, EntryForms are requested to the Entry Id that is to be updated using getEntryFormsForUpdate() where the reference Id in the EntryForm may be used to link the request. Similarly, the EntryForm has metadata about the data that can be updated and it can perform validation before submitting the update. The EntryForm can only be used once for a successful update and cannot be reused.

Once a batch of EntryForms are submitted for update, an UpdateResponse is returned for each EntryForm, although the ordering is not defined. Only errors that pertain to the entire update operation are returned from updateEntries(), errors specific to an individual EntryForm are indicated in the corresponding UpdateResponse. UpdateResponses may be linked to the originating EntryForm through the EntryForm Id.

The delete operations delete Entries in bulk. To unmap an Entry from the current Business, the EntryBusinessAssignmentSession should be used. These delete operations attempt to remove the Entry itself thus removing it from all known Business catalogs. Bulk delete operations return the results in DeleteResponses.

MethodgetEntryFormsForCreate
Description

Gets the entry forms for creating a bunch of new entries. A form is returned for each supplied customer, item, and period set.

Parametersosid.billing.batch.EntryPeerListpeersthe entry peers
osid.type.Type[]entryRecordTypesarray of entry record types to be included in each create operation or an empty list if none
Returnosid.billing.batch.EntryBatchFormListthe entry forms
ErrorsNOT_FOUNDa customerId, itemId, or periodId is not found
NULL_ARGUMENT peers or entryRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateEntries
Description

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

Parametersosid.billing.batch.EntryBatchFormListentryFormsthe entry forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT entryForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetEntryFormsForUpdate
Description

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

Parametersosid.id.IdListentryIdsthe Ids of the Entry
Returnosid.billing.batch.EntryBatchFormListthe entry form
ErrorsNOT_FOUNDan entryId is not found
NULL_ARGUMENT entryIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateEntries
Description

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

Parametersosid.billing.batch.EntryBatchFormListentryFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT entryForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllEntries
Description

Deletes all Entries in this Business .

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

Deletes entries for the given Ids.

Parametersosid.id.IdListentryIdsthe Ids of the entries to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT entryIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteEntriesForCustomer
Description

Deletes entries for the given customer.

Parametersosid.id.IdcustomerIdan Id of a customer
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT customerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteEntriesForPeriod
Description

Deletes entries for the given period.

Parametersosid.id.IdperiodIdan Id of a period
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT periodId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteIneffectiveEntriesByDate
Description

Deletes entries expired before the given date.

Parametersosid.calendaring.DateTimedatea date
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT date is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasEntries
Description

Adds an Id to an Entry for the purpose of creating compatibility. The primary Id of the Entry is determined by the provider. The new Id is an alias to the primary Id. If the alias is a pointer to another entry, it is reassigned to the given entry 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.