OSID - osid.financials.FiscalPeriodLookupSession Service Interface Definition

Interface	osid.financials.FiscalPeriodLookupSession
Implements	`osid.OsidSession`
Description	This session defines methods for retrieving fiscal periods. This lookup session defines several views: comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete result set or is an error condition isolated business view: All fiscal period methods in this session operate, retrieve and pertain to fiscal periods defined explicitly in the current business. Using an isolated view is useful for managing `FiscalPeriods` with the `FiscalPeriodAdminSession.` federated business view: All fiscal period lookup methods in this session operate, retrieve and pertain to all fiscal periods defined in this business and any other fiscal periods implicitly available in this business through business inheritence. The methods `useFederatedBusinessView()` and `useIsolatedBusinessView()` behave as a radio group and one should be selected before invoking any lookup methods.
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	canLookupFiscalPeriods
Description	Tests if this user can perform `FiscalPeriod` lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may not offer lookup operations to unauthorized users.
Return	`boolean`		`false` if lookup methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeFiscalPeriodView
Description	The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.
Compliance	`mandatory`		This method is must be implemented.
Method	usePlenaryFiscalPeriodView
Description	A complete view of the `FiscalPeriod` returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.
Compliance	`mandatory`		This method is must be implemented.
Method	useFederatedBusinessView
Description	Federates the view for methods in this session. A federated view will include fiscal periods in catalogs which are children of this catalog in the business hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedBusinessView
Description	Isolates the view for methods in this session. An isolated view restricts retrievals to this business only.
Compliance	`mandatory`		This method is must be implemented.
Method	getFiscalPeriod
Description	Gets the `FiscalPeriod` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `FiscalPeriod` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `FiscalPeriod` and retained for compatibility.
Parameters	`osid.id.Id`	`fiscalPeriodId`	the `Id` of the `FiscalPeriod` to retrieve
Return	`osid.financials.FiscalPeriod`		the returned `FiscalPeriod`
Errors	NOT_FOUND		no `FiscalPeriod` found with the given `Id`
	NULL_ARGUMENT		`fiscalPeriodId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getFiscalPeriodsByIds
Description	Gets a `FiscalPeriodList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the fiscal periods specified in the `Id` list, in the order of the list, including duplicates, or an error results if an `Id` in the supplied list is not found or inaccessible. Otherwise, inaccessible `FiscalPeriods` may be omitted from the list and may present the elements in any order including returning a unique set.
Parameters	`osid.id.IdList`	`fiscalPeriodIds`	the list of `Ids` to retrieve
Return	`osid.financials.FiscalPeriodList`		the returned `FiscalPeriod` list
Errors	NOT_FOUND		an `Id was` 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	getFiscalPeriodsByGenusType
Description	Gets a `FiscalPeriodList` corresponding to the given fiscal period genus `Type` which does not include fiscal periods of types derived from the specified `Type.` In plenary mode, the returned list contains all known fiscal periods or an error results. Otherwise, the returned list may contain only those fiscal periods that are accessible through this session.
Parameters	`osid.type.Type`	`fiscalPeriodGenusType`	a fiscal period genus type
Return	`osid.financials.FiscalPeriodList`		the returned `FiscalPeriod` list
Errors	NULL_ARGUMENT		`fiscalPeriodGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getFiscalPeriodsByParentGenusType
Description	Gets a `FiscalPeriodList` corresponding to the given fiscal period genus `Type` and include any additional fiscal periods with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known fiscal periods or an error results. Otherwise, the returned list may contain only those fiscal periods that are accessible through this session.
Parameters	`osid.type.Type`	`fiscalPeriodGenusType`	a fiscal period genus type
Return	`osid.financials.FiscalPeriodList`		the returned `FiscalPeriod` list
Errors	NULL_ARGUMENT		`fiscalPeriodGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getFiscalPeriodsByRecordType
Description	Gets a `FiscalPeriodList` containing the given fiscal period record `Type.` In plenary mode, the returned list contains all known fiscal periods or an error results. Otherwise, the returned list may contain only those fiscal periods that are accessible through this session.
Parameters	`osid.type.Type`	`fiscalPeriodRecordType`	a fiscal period record type
Return	`osid.financials.FiscalPeriodList`		the returned `FiscalPeriod` list
Errors	NULL_ARGUMENT		`fiscalPeriodRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getFiscalPeriodsByDate
Description	Gets a `FiscalPeriodList` containing the given date `.` In plenary mode, the returned list contains all known fiscal periods or an error results. Otherwise, the returned list may contain only those fiscal periods that are accessible through this session.
Parameters	`osid.calendaring.DateTime`	`date`	a date
Return	`osid.financials.FiscalPeriodList`		the returned `FiscalPeriod` list
Errors	NULL_ARGUMENT		`date` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getFiscalPeriods
Description	Gets all `FiscalPeriods.` In plenary mode, the returned list contains all known fiscal periods or an error results. Otherwise, the returned list may contain only those fiscal periods that are accessible through this session.
Return	`osid.financials.FiscalPeriodList`		a list of `FiscalPeriods`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.