Interface | osid.financials.FiscalPeriodAdminSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create a For updates, The delete operations delete This session includes an | ||
Method | getBusinessId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Business Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getBusiness | ||
Description |
Gets the | ||
Return | osid.financials.Business | the business | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canCreateFiscalPeriods | ||
Description |
Tests if this user can create | ||
Return | boolean | false if FiscalPeriod creation is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateFiscalPeriodWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | fiscalPeriodRecordTypes | array of fiscal period record types |
Return | boolean | true if FiscalPeriod creation using the
specified record Types is supported, false
otherwise | |
Errors | NULL_ARGUMENT | fiscalPeriodRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getFiscalPeriodFormForCreate | ||
Description |
Gets the fiscal period form for creating new fiscal periods. A new form should be requested for each create transaction. | ||
Parameters | osid.type.Type[] | fiscalPeriodRecordTypes | array of fiscal period record types |
Return | osid.financials.FiscalPeriodForm | the fiscal period form | |
Errors | NULL_ARGUMENT | fiscalPeriodRecordTypes is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to get form for requested record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createFiscalPeriod | ||
Description |
Creates a new | ||
Parameters | osid.financials.FiscalPeriodForm | fiscalPeriodForm | the form for this FiscalPeriod |
Return | osid.financials.FiscalPeriod | the new FiscalPeriod | |
Errors | ILLEGAL_STATE | fiscalPeriodForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NOT_FOUND | fiscalPeriodForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | fiscalPeriodForm did not originate from
getFiscalPeriodFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateFiscalPeriods | ||
Description |
Tests if this user can update | ||
Return | boolean | false if FiscalPeriod modification is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getFiscalPeriodFormForUpdate | ||
Description |
Gets the fiscal period form for updating an existing fiscal period. A new fiscal period form should be requested for each update transaction. | ||
Parameters | osid.id.Id | fiscalPeriodId | the Id of the FiscalPeriod |
Return | osid.financials.FiscalPeriodForm | the fiscal period form | |
Errors | NOT_FOUND | fiscalPeriodId is not found | |
NULL_ARGUMENT | fiscalPeriodId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateFiscalPeriod | ||
Description |
Updates an existing fiscal period. | ||
Parameters | osid.financials.FiscalPeriodForm | fiscalPeriodForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | fiscalPeriodForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | fiscalPeriodForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | fiscalPeriodForm did not originate from
getFiscalPeriodFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteFiscalPeriods | ||
Description |
Tests if this user can delete | ||
Return | boolean | false if FiscalPeriod deletion is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteFiscalPeriod | ||
Description |
Deletes a | ||
Parameters | osid.id.Id | fiscalPeriodId | the Id of the FiscalPeriod to remove |
Errors | NOT_FOUND | fiscalPeriodId not found | |
NULL_ARGUMENT | fiscalPeriodId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageFiscalPeriodAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if FiscalPeriod aliasing is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasFiscalPeriod | ||
Description |
Adds an | ||
Parameters | osid.id.Id | fiscalPeriodId | the Id of a FiscalPeriod |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is in use as a primary Id | |
NOT_FOUND | fiscalPeriodId not found | ||
NULL_ARGUMENT | fiscalPeriodId or aliasId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |