OSID - osid.inventory.ModelLookupSession Service Interface Definition

Interface	osid.inventory.ModelLookupSession
Implements	`osid.OsidSession`
Used By	`osid.inventory.InventoryManager`
Used By	`osid.inventory.InventoryProxyManager`
Description	This session defines methods for retrieving models. 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 warehouse view: All model methods in this session operate, retrieve and pertain to models defined explicitly in the current warehouse. Using an isolated view is useful for managing `Models` with the `ModelAdminSession`. federated warehouse view: All model lookup methods in this session operate, retrieve and pertain to all models defined in this warehouse and any other models implicitly available in this warehouse through warehouse inheritence. The methods `useFederatedWarehouseView()` and `useIsolatedWarehouseView()` behave as a radio group and one should be selected before invoking any lookup methods.
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	canLookupModels
Description	Tests if this user can perform `Model` 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	useComparativeModelView
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	usePlenaryModelView
Description	A complete view of the `Model` 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	useFederatedWarehouseView
Description	Federates the view for methods in this session. A federated view will include models in catalogs which are children of this catalog in the warehouse hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedWarehouseView
Description	Isolates the view for methods in this session. An isolated view restricts retrievals to this warehouse only.
Compliance	`mandatory`		This method is must be implemented.
Method	getModel
Description	Gets the `Model` specified by its `Id`. In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Model` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `Model` and retained for compatibility.
Parameters	`osid.id.Id`	`modelId`	the `Id` of the `Model` to retrieve
Return	`osid.inventory.Model`		the returned `Model`
Errors	NOT_FOUND		no `Model` found with the given `Id`
	NULL_ARGUMENT		`modelId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getModelsByIds
Description	Gets a `ModelList` corresponding to the given `IdList`. In plenary mode, the returned list contains all of the models 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 `Models` may be omitted from the list and may present the elements in any order including returning a unique set.
Parameters	`osid.id.IdList`	`modelIds`	the list of `Ids` to retrieve
Return	`osid.inventory.ModelList`		the returned `Model` list
Errors	NOT_FOUND		an `Id` was not found
	NULL_ARGUMENT		`modelIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getModelsByGenusType
Description	Gets a `ModelList` corresponding to the given model genus `Type` which does not include models of types derived from the specified `Type`. In plenary mode, the returned list contains all known models or an error results. Otherwise, the returned list may contain only those models that are accessible through this session.
Parameters	`osid.type.Type`	`modelGenusType`	a model genus type
Return	`osid.inventory.ModelList`		the returned `Model` list
Errors	NULL_ARGUMENT		`modelGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getModelsByParentGenusType
Description	Gets a `ModelList` corresponding to the given model genus `Type` and include any additional models with genus types derived from the specified `Type`. In plenary mode, the returned list contains all known models or an error results. Otherwise, the returned list may contain only those models that are accessible through this session.
Parameters	`osid.type.Type`	`modelGenusType`	a model genus type
Return	`osid.inventory.ModelList`		the returned `Model` list
Errors	NULL_ARGUMENT		`modelGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getModelsByRecordType
Description	Gets a `ModelList` containing the given model record `Type`. In plenary mode, the returned list contains all known models or an error results. Otherwise, the returned list may contain only those models that are accessible through this session.
Parameters	`osid.type.Type`	`modelRecordType`	a model record type
Return	`osid.inventory.ModelList`		the returned `Model` list
Errors	NULL_ARGUMENT		`modelRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getModelsByManufacturer
Description	Gets a `ModelList` for the given resource `Id`. In plenary mode, the returned list contains all known models or an error results. Otherwise, the returned list may contain only those models that are accessible through this session.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Return	`osid.inventory.ModelList`		the returned `Model` list
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getModels
Description	Gets all `Models`. In plenary mode, the returned list contains all known models or an error results. Otherwise, the returned list may contain only those models that are accessible through this session.
Return	`osid.inventory.ModelList`		a list of `Models`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.