OSID - osid.financials.FiscalPeriodAdminSession Service Interface Definition

Interface	osid.financials.FiscalPeriodAdminSession
Implements	`osid.OsidSession`
Implemented By	`osid.financials.batch.FiscalPeriodBatchAdminSession`
Used By	`osid.financials.FinancialsManager`
Used By	`osid.financials.FinancialsProxyManager`
Description	This session creates, updates, and deletes `FiscalPeriods`. The data for create and update is provided by the consumer via the form. `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 `getFiscalPeriodFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `FiscalPeriodForm` 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 the `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. For updates, `FiscalPeriodForms` are requested to the `FiscalPeriod` `Id` that is to be updated using `getFiscalPeriodFormForUpdate()`. 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. The delete operations delete `FiscalPeriods`. 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. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	getBusinessId
Description	Gets the `Business` `Id` associated with this session.
Return	`osid.id.Id`		the `Business Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getBusiness
Description	Gets the `Business` associated with this session.
Return	`osid.financials.Business`		the business
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreateFiscalPeriods
Description	Tests if this user can create `FiscalPeriods`. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `FiscalPeriod` will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer create operations to an unauthorized user.
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 `FiscalPeriod` using the desired record types. While `FinancialsManager.getFiscalPeriodRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `FiscalPeriod`. Providing an empty array tests if a `FiscalPeriod` can be created with no records.
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 `FiscalPeriod`.
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 `FiscalPeriods`. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `FiscalPeriod` will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer update operations to an unauthorized user.
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 `FiscalPeriods`. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `FiscalPeriod` will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer delete operations to an unauthorized user.
Return	`boolean`		`false` if `FiscalPeriod` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteFiscalPeriod
Description	Deletes a `FiscalPeriod`.
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 `Id` aliases for `FiscalPeriods`. A return of true does not guarantee successful authorization. A return of false indicates that it is known changing an alias will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer alias operations to an unauthorized user.
Return	`boolean`		`false` if `FiscalPeriod` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasFiscalPeriod
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` performs as 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`.
Parameters	`osid.id.Id`	`fiscalPeriodId`	the `Id` of a `FiscalPeriod`
Parameters	`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.