OSID - osid.inventory.ModelSmartWarehouseSession Service Interface Definition

Interface	osid.inventory.ModelSmartWarehouseSession
Implements	`osid.OsidSession`
Used By	`osid.inventory.InventoryManager`
Used By	`osid.inventory.InventoryProxyManager`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. A `ModelQuery` can be retrieved from this session and mapped to this `CoursOfferingeCatalog` to create a virtual collection of `Models`. The models may be sequenced using the `ModelSearchOrder` from this session. This `Warehouse` has a default query that matches any model and a default search order that specifies no sequencing. The queries may be examined using a `ModelQueryInspector`. The query may be modified by converting the inspector back to a `ModelQuery`.
Method	getWarehouseId
Description	Gets the `Warehouse` `Id` associated with this session.
Return	`osid.id.Id`		the `Warehouse Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getWarehouse
Description	Gets the `Warehouse` associated with this session.
Return	`osid.inventory.Warehouse`		the warehouse
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageSmartWarehouses
Description	Tests if this user can manage smart warehouses. 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 warehouse management is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getModelQuery
Description	Gets a model query.
Return	`osid.inventory.ModelQuery`		the model query
Compliance	`mandatory`		This method must be implemented.
Method	getModelSearchOrder
Description	Gets a model search order.
Return	`osid.inventory.ModelSearchOrder`		the model search order
Compliance	`mandatory`		This method must be implemented.
Method	applyModelQuery
Description	Applies a model query to this warehouse.
Parameters	`osid.inventory.ModelQuery`	`modelQuery`	the model query
Errors	NULL_ARGUMENT		`modelQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`modelQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectModelQuery
Description	Gets a model query inspector for this warehouse.
Return	`osid.inventory.ModelQueryInspector`		the model query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyModelSequencing
Description	Applies a model search order to this warehouse.
Parameters	`osid.inventory.ModelSearchOrder`	`modelSearchOrder`	the model search order
Errors	NULL_ARGUMENT		`modelSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`modelSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getModelQueryFromInspector
Description	Gets a model query from an inspector.
Parameters	`osid.inventory.ModelQueryInspector`	`modelQueryInspector`	a query inspector
Return	`osid.inventory.ModelQuery`		the model query
Errors	NULL_ARGUMENT		`modelQueryInspector` is `null`
Errors	UNSUPPORTED		`modelQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.