OSID - osid.financials.FiscalPeriodSmartBusinessSession Service Interface Definition

Interface	osid.financials.FiscalPeriodSmartBusinessSession
Implements	`osid.OsidSession`
Used By	`osid.financials.FinancialsManager`
Used By	`osid.financials.FinancialsProxyManager`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. A `FiscalPeriodQuery` can be retrieved from this session and mapped to this `Business` to create a virtual collection of `FiscalPeriods`. The fiscal periods may be sequenced using the `FiscalPeriodSearchOrder` from this session. This `Business` has a default query that matches any fiscal period and a default search order that specifies no sequencing. The queries may be examined using a `FiscalPeriodQueryInspector`. The query may be modified by converting the inspector back to a `FiscalPeriodQuery`.
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	canManageSmartBusinesses
Description	Tests if this user can manage smart businesses. A return of true does not guarantee successful assessment. A return of false indicates that it is known methods in this session will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer operations to unauthorized users.
Return	`boolean`		`false` if smart business management is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getFiscalPeriodQuery
Description	Gets a fiscal period query.
Return	`osid.financials.FiscalPeriodQuery`		the fiscal period query
Compliance	`mandatory`		This method must be implemented.
Method	getFiscalPeriodSearchOrder
Description	Gets a fiscal period search order.
Return	`osid.financials.FiscalPeriodSearchOrder`		the fiscal period search order
Compliance	`mandatory`		This method must be implemented.
Method	applyFiscalPeriodQuery
Description	Applies a fiscal period query to this business.
Parameters	`osid.financials.FiscalPeriodQuery`	`fiscalPeriodQuery`	the fiscal period query
Errors	NULL_ARGUMENT		`fiscalPeriodQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`fiscalPeriodQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectFiscalPeriodQuery
Description	Gets a fiscal period query inspector for this business.
Return	`osid.financials.FiscalPeriodQueryInspector`		the fiscal period query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyFiscalPeriodSequencing
Description	Applies a fiscal period search order to this business.
Parameters	`osid.financials.FiscalPeriodSearchOrder`	`fiscalPeriodSearchOrder`	the fiscal period search order
Errors	NULL_ARGUMENT		`fiscalPeriodSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`fiscalPeriodSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getFiscalPeriodQueryFromInspector
Description	Gets a fiscal period query from an inspector.
Parameters	`osid.financials.FiscalPeriodQueryInspector`	`fiscalPeriodQueryInspector`	a query inspector
Return	`osid.financials.FiscalPeriodQuery`		the fiscal period query
Errors	NULL_ARGUMENT		`fiscalPeriodQueryInspector` is `null`
Errors	UNSUPPORTED		`fiscalPeriodQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.