OSID Logo
OSID Specifications
billing batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.billing.batch.PeriodBatchAdminSession
Implementsosid.billing.PeriodAdminSession
Description

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

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

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

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

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

The delete operations delete Periods in bulk. To unmap a Period from the current Business, the PeriodBusinessAssignmentSession should be used. These delete operations attempt to remove the Period itself thus removing it from all known Business catalogs. Bulk delete operations return the results in DeleteResponses.

MethodgetPeriodFormsForCreate
Description

Gets the period forms for creating a bunch of new periods.

Parameterscardinalnumberthe number of forms to retrieve
osid.type.Type[]periodRecordTypesarray of period record types to be included in each create operation or an empty list if none
Returnosid.billing.batch.PeriodBatchFormListthe period forms
ErrorsNULL_ARGUMENT periodRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreatePeriods
Description

Creates a new set of Periods. 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.PeriodBatchFormListperiodFormsthe period forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT periodForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetPeriodFormsForUpdate
Description

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

Parametersosid.id.IdListperiodIdsthe Ids of the Period
Returnosid.billing.batch.PeriodBatchFormListthe period form
ErrorsNOT_FOUNDa periodId is not found
NULL_ARGUMENT periodIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdatePeriods
Description

Updates existing periods. 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.PeriodBatchFormListperiodFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT periodForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllPeriods
Description

Deletes all Periods in this Business .

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

Deletes periods for the given Ids.

Parametersosid.id.IdListperiodIdsthe Ids of the periods to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT periodIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeletePeriodsByDate
Description

Deletes periods containing 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.
MethodaliasPeriods
Description

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