OSID Logo
OSID Specifications
financials batch package
Version 3.1.0
Interfaceosid.financials.batch.FiscalPeriodBatchAdminSession
Implementsosid.financials.FiscalPeriodAdminSession
Used Byosid.financials.batch.FinancialsBatchManager
osid.financials.batch.FinancialsBatchProxyManager
Description

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

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

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

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

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

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

MethodgetFiscalPeriodFormsForCreate
Description

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

Parameterscardinalnumber the number of forms to retrieve
osid.type.Type[]fiscalPeriodRecordTypes array of fiscal period record types to be included in each create operation or an empty list if none
Returnosid.financials.batch.FiscalPeriodBatchFormList the fiscal period forms
ErrorsNULL_ARGUMENT fiscalPeriodRecordTypes is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
UNSUPPORTED unable to request forms with given record types
Compliancemandatory This method must be implemented.
MethodcreateFiscalPeriods
Description

Creates a new set of FiscalPeriods. 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.FiscalPeriodBatchFormListfiscalPeriodForms the fiscal period forms
Returnosid.transaction.batch.CreateResponseList the create responses
ErrorsNULL_ARGUMENT fiscalPeriodForms is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodgetFiscalPeriodFormsForUpdate
Description

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

Parametersosid.id.IdListfiscalPeriodIds the Ids of the FiscalPeriod
Returnosid.financials.batch.FiscalPeriodBatchFormList the fiscal period form
ErrorsNOT_FOUND a fiscalPeriodId is not found
NULL_ARGUMENT fiscalPeriodIds is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodupdateFiscalPeriods
Description

Updates existing fiscal 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.financials.batch.FiscalPeriodBatchFormListfiscalPeriodForms the form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseList the update responses
ErrorsNULL_ARGUMENT fiscalPeriodForms is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethoddeleteAllFiscalPeriods
Description

Deletes all FiscalPeriods in this Business.

Returnosid.transaction.batch.DeleteResponseList the delete responses
ErrorsOPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethoddeleteFiscalPeriods
Description

Deletes fiscal periods for the given Ids.

Parametersosid.id.IdListfiscalPeriodIds the Ids of the fiscal periods to delete
Returnosid.transaction.batch.DeleteResponseList the delete responses
ErrorsNULL_ARGUMENT fiscalPeriodIds is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethoddeleteFiscalPeriodsByDate
Description

Deletes fiscal periods containing the given date.

Parametersosid.calendaring.DateTimedate a date
Returnosid.transaction.batch.DeleteResponseList the delete responses
ErrorsNULL_ARGUMENT date is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodaliasFiscalPeriods
Description

Adds an Id to a FiscalPeriod for the purpose of creating compatibility. The primary Id of the FiscalPeriod is determined by the provider. The new Id is an alias to the primary Id. If the alias is a pointer to another fiscal period, it is reassigned to the given fiscal period Id.

Parametersosid.transaction.batch.AliasRequestListaliasRequests the alias requests
Returnosid.transaction.batch.AliasResponseList the alias responses
ErrorsNULL_ARGUMENT aliasRequests is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.