Interface | osid.financials.batch.FiscalPeriodBatchAdminSession | ||
---|---|---|---|
Implements | osid.financials.FiscalPeriodAdminSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create a The Once a batch of For updates, Once a batch of The delete operations delete | ||
Method | getFiscalPeriodFormsForCreate | ||
Description |
Gets the fiscal period forms for creating a bunch of new fiscal periods. | ||
Parameters | cardinal | number | 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 | |
Return | osid.financials.batch.FiscalPeriodBatchFormList | the fiscal period forms | |
Errors | NULL_ARGUMENT | fiscalPeriodRecordTypes is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to request forms with given record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createFiscalPeriods | ||
Description |
Creates a new set of | ||
Parameters | osid.financials.batch.FiscalPeriodBatchFormList | fiscalPeriodForms | the fiscal period forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | fiscalPeriodForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getFiscalPeriodFormsForUpdate | ||
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. | ||
Parameters | osid.id.IdList | fiscalPeriodIds | the Ids of the FiscalPeriod |
Return | osid.financials.batch.FiscalPeriodBatchFormList | the fiscal period form | |
Errors | NOT_FOUND | a fiscalPeriodId is not found | |
NULL_ARGUMENT | fiscalPeriodIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateFiscalPeriods | ||
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
| ||
Parameters | osid.financials.batch.FiscalPeriodBatchFormList | fiscalPeriodForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | fiscalPeriodForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllFiscalPeriods | ||
Description |
Deletes all | ||
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteFiscalPeriods | ||
Description |
Deletes fiscal periods for the given | ||
Parameters | osid.id.IdList | fiscalPeriodIds | the Ids of the fiscal periods to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | fiscalPeriodIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteFiscalPeriodsByDate | ||
Description |
Deletes fiscal periods containing the given date. | ||
Parameters | osid.calendaring.DateTime | date | a date |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | date is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | aliasFiscalPeriods | ||
Description |
Adds an | ||
Parameters | osid.transaction.batch.AliasRequestList | aliasRequests | the alias requests |
Return | osid.transaction.batch.AliasResponseList | the alias responses | |
Errors | NULL_ARGUMENT | aliasRequests is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |