org.osid.billing.batch

Interface PeriodBatchAdminSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession, PeriodAdminSession

public interface PeriodBatchAdminSession
extends PeriodAdminSession

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.

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasPeriods(AliasRequestList aliasRequests) Adds an Id to a Period for the purpose of creating compatibility.
CreateResponseList	createPeriods(PeriodBatchFormList periodForms) Creates a new set of Periods.
DeleteResponseList	deleteAllPeriods() Deletes all Periods in this Business .
DeleteResponseList	deletePeriods(IdList periodIds) Deletes periods for the given Ids.
DeleteResponseList	deletePeriodsByDate(DateTime date) Deletes periods containing the given date.
PeriodBatchFormList	getPeriodFormsForCreate(long number, Type[] periodRecordTypes) Gets the period forms for creating a bunch of new periods.
PeriodBatchFormList	getPeriodFormsForUpdate(IdList periodIds) Gets the period forms for updating an existing set of periods.
UpdateResponseList	updatePeriods(PeriodBatchFormList periodForms) Updates existing periods.

Methods inherited from interface org.osid.billing.PeriodAdminSession

aliasPeriod, canCreatePeriods, canCreatePeriodWithRecordTypes, canDeletePeriods, canManagePeriodAliases, canUpdatePeriods, createPeriod, deletePeriod, getBusiness, getBusinessId, getPeriodFormForCreate, getPeriodFormForUpdate, updatePeriod

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getPeriodFormsForCreate

PeriodBatchFormList getPeriodFormsForCreate(long number,
                                          Type[] periodRecordTypes)
                                            throws OperationFailedException,
                                                   PermissionDeniedException

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

Parameters:

number - the number of forms to retrieve

periodRecordTypes - array of period record types to be included in each create operation or an empty list if none

Returns:

the period forms

Throws:

NullArgumentException - periodRecordTypes is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - unable to request forms with given record types

Compliance:

mandatory - This method must be implemented.

createPeriods

CreateResponseList createPeriods(PeriodBatchFormList periodForms)
                                 throws OperationFailedException,
                                        PermissionDeniedException

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 .

Parameters:

periodForms - the period forms

Returns:

the create responses

Throws:

NullArgumentException - periodForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPeriodFormsForUpdate

PeriodBatchFormList getPeriodFormsForUpdate(IdList periodIds)
                                            throws NotFoundException,
                                                   OperationFailedException,
                                                   PermissionDeniedException

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

Parameters:

periodIds - the Ids of the Period

Returns:

the period form

Throws:

NotFoundException - a periodId is not found

NullArgumentException - periodIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updatePeriods

UpdateResponseList updatePeriods(PeriodBatchFormList periodForms)
                                 throws OperationFailedException,
                                        PermissionDeniedException

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 .

Parameters:

periodForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - periodForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllPeriods

DeleteResponseList deleteAllPeriods()
                                    throws OperationFailedException,
                                           PermissionDeniedException

Deletes all Periods in this Business .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deletePeriods

DeleteResponseList deletePeriods(IdList periodIds)
                                 throws OperationFailedException,
                                        PermissionDeniedException

Deletes periods for the given Ids.

Parameters:

periodIds - the Ids of the periods to delete

Returns:

the delete responses

Throws:

NullArgumentException - periodIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deletePeriodsByDate

DeleteResponseList deletePeriodsByDate(DateTime date)
                                       throws OperationFailedException,
                                              PermissionDeniedException

Deletes periods containing the given date.

Parameters:

date - a date

Returns:

the delete responses

Throws:

NullArgumentException - date is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasPeriods

AliasResponseList aliasPeriods(AliasRequestList aliasRequests)
                               throws OperationFailedException,
                                      PermissionDeniedException

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.

Parameters:

aliasRequests - the alias requests

Returns:

the alias responses

Throws:

NullArgumentException - aliasRequests is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.