OSID - osid.resourcing.AvailabilitySmartFoundrySession Service Interface Definition

Interface	osid.resourcing.AvailabilitySmartFoundrySession
Implements	`osid.OsidSession`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. An `AvailabilityQuery` can be retrieved from this session and foundryped to this `Foundry` to create a virtual collection of `Availabilities.` The availabilities may be sequenced using the `AvailabilitySearchOrder` from this session. This `Foundry` has a default query that matches any availability and a default search order that specifies no sequencing. The queries may be examined using an `AvailabilityQueryInspector.` The query may be modified by converting the inspector back to an `AvailabilityQuery.`
Method	getFoundryId
Description	Gets the `Foundry` `Id` associated with this session.
Return	`osid.id.Id`		the `Foundry Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getFoundry
Description	Gets the `Foundry` associated with this session.
Return	`osid.resourcing.Foundry`		the foundry
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageSmartFoundries
Description	Tests if this user can manage smart foundries. A return of true does not guarantee successful authorization. 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 foundry management is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAvailabilityQuery
Description	Gets an availability query.
Return	`osid.resourcing.AvailabilityQuery`		the availability query
Compliance	`mandatory`		This method must be implemented.
Method	getAvailabilitySearchOrder
Description	Gets an availability search order.
Return	`osid.resourcing.AvailabilitySearchOrder`		the availability search order
Compliance	`mandatory`		This method must be implemented.
Method	applyAvailabilityQuery
Description	Applies an availability query to this foundry.
Parameters	`osid.resourcing.AvailabilityQuery`	`availabilityQuery`	the availability query
Errors	NULL_ARGUMENT		`availabilityQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`availabilityQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspecAvailabilityQuery
Description	Gets an availability query inspector for this foundry.
Return	`osid.resourcing.AvailabilityQueryInspector`		the availability query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyAvailabilitySequencing
Description	Applies an availability search order to this foundry.
Parameters	`osid.resourcing.AvailabilitySearchOrder`	`availabilitySearchOrder`	the availability search order
Errors	NULL_ARGUMENT		`availabilitySearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`availabilitySearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getAvailabilityQueryFromInspector
Description	Gets an availability query from an inspector.
Parameters	`osid.resourcing.AvailabilityQueryInspector`	`availabilityQueryInspector`	an availability query inspector
Return	`osid.resourcing.AvailabilityQuery`		the availability query
Errors	NULL_ARGUMENT		`availabilityQueryInspector` is `null`
Errors	UNSUPPORTED		`availabilityQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.