OSID - osid.learning.ProficiencyLookupSession Service Interface Definition

Interface	osid.learning.ProficiencyLookupSession
Implements	`osid.OsidSession`
Description	This session defines methods for retrieving proficiencies. 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 objective bank view: All proficiency methods in this session operate, retrieve and pertain to proficiencies defined explicitly in the current objective bank. Using an isolated view is useful for managing `Proficiencies` with the `ProficiencyAdminSession.` federated objective bank view: All proficiency lookup methods in this session operate, retrieve and pertain to all proficiencies defined in this objective bank and any other proficiencies implicitly available in this objective bank through objective bank inheritence. effective proficiency view: All proficiency lookup methods return proficiencies where the current date falls in between the effective dates inclusive. any proficiency view: Proficiencies of any effective date are returned from methods. The methods `useFederatedObjectiveBankView()` and `useIsolatedObjectiveBankView()` behave as a radio group and one should be selected before invoking any lookup methods. Proficiencies may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the `Proficiencies.`
Method	getObjectiveBankId
Description	Gets the `ObjectiveBank` `Id` associated with this session.
Return	`osid.id.Id`		the `ObjectiveBank Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getObjectiveBank
Description	Gets the `ObjectiveBank` associated with this session.
Return	`osid.learning.ObjectiveBank`		the obective bank
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canLookupProficiencies
Description	Tests if this user can perform `Proficiency` 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	useComparativeProficiencyView
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	usePlenaryProficiencyView
Description	A complete view of the `Proficiency` 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	useFederatedObjectiveBankView
Description	Federates the view for methods in this session. A federated view will include proficiencies in objective banks which are children of this objective bank in the obective bank hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedObjectiveBankView
Description	Isolates the view for methods in this session. An isolated view restricts retrievals to this objective bank only.
Compliance	`mandatory`		This method is must be implemented.
Method	useEffectiveProficiencyView
Description	Only proficiencies whose effective dates are current are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyEffectiveProficiencyView
Description	All proficienies of any effective dates are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getProficiency
Description	Gets the `Proficiency` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Proficiency` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `Proficiency` and retained for compatibility. In effective mode, proficiencies are returned that are currently effective. In any effective mode, effective proficiencies and those currently expired are returned.
Parameters	`osid.id.Id`	`proficiencyId`	the `Id` of the `Proficiency` to retrieve
Return	`osid.learning.Proficiency`		the returned `Proficiency`
Errors	NOT_FOUND		no `Proficiency` found with the given `Id`
	NULL_ARGUMENT		`proficiencyId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProficienciesByIds
Description	Gets a `ProficiencyList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the proficiencies 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 `Proficiencies` may be omitted from the list and may present the elements in any order including returning a unique set. In effective mode, proficiencies are returned that are currently effective. In any effective mode, effective proficiencies and those currently expired are returned.
Parameters	`osid.id.IdList`	`proficiencyIds`	the list of `Ids` to retrieve
Return	`osid.learning.ProficiencyList`		the returned `Proficiency` list
Errors	NOT_FOUND		an `Id` was not found
	NULL_ARGUMENT		`proficiencyIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProficienciesByGenusType
Description	Gets a `ProficiencyList` corresponding to the given proficiency genus `Type` which does not include proficiencies of types derived from the specified `Type.` In plenary mode, the returned list contains all known proficiencies or an error results. Otherwise, the returned list may contain only those proficiencies that are accessible through this session. In effective mode, proficiencies are returned that are currently effective. In any effective mode, effective proficiencies and those currently expired are returned.
Parameters	`osid.type.Type`	`proficiencyGenusType`	a proficiency genus type
Return	`osid.learning.ProficiencyList`		the returned `Proficiency` list
Errors	NULL_ARGUMENT		`proficiencyGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProficienciesByParentGenusType
Description	Gets a `ProficiencyList` corresponding to the given proficiency genus `Type` and include any additional proficiencies with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known proficiencies or an error results. Otherwise, the returned list may contain only those proficiencies that are accessible through this session. In effective mode, proficiencies are returned that are currently effective. In any effective mode, effective proficiencies and those currently expired are returned.
Parameters	`osid.type.Type`	`proficiencyGenusType`	a proficiency genus type
Return	`osid.learning.ProficiencyList`		the returned `Proficiency` list
Errors	NULL_ARGUMENT		`proficiencyGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProficienciesByRecordType
Description	Gets a `ProficiencyList` containing the given proficiency record `Type.` In plenary mode, the returned list contains all known proficiencies or an error results. Otherwise, the returned list may contain only those proficiencies that are accessible through this session. In effective mode, proficiencies are returned that are currently effective. In any effective mode, effective proficiencies and those currently expired are returned.
Parameters	`osid.type.Type`	`proficiencyRecordType`	a proficiency record type
Return	`osid.learning.ProficiencyList`		the returned `Proficiency` list
Errors	NULL_ARGUMENT		`proficiencyRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProficienciesOnDate
Description	Gets a `ProficiencyList` effecyive during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known proficiencies or an error results. Otherwise, the returned list may contain only those proficiencies that are accessible through this session. In effective mode, proficiencies are returned that are currently effective. In any effective mode, effective proficiencies and those currently expired are returned.
Parameters	`osid.calendaring.DateTime`	`from`	starting date
Parameters	`osid.calendaring.DateTime`	`to`	ending date
Return	`osid.learning.ProficiencyList`		the returned `Proficiency` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProficienciesByGenusTypeOnDate
Description	Gets a `ProficiencyList` of the given proficiency genus type effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known proficiencies or an error results. Otherwise, the returned list may contain only those proficiencies that are accessible through this session. In effective mode, proficiencies are returned that are currently effective. In any effective mode, effective proficiencies and those currently expired are returned.
Parameters	`osid.type.Type`	`proficiencyGenusType`	a proficiency genus type
	`osid.calendaring.DateTime`	`from`	starting date
	`osid.calendaring.DateTime`	`to`	ending date
Return	`osid.learning.ProficiencyList`		the returned `Proficiency` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`proficiencyGenusType, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProficienciesForObjective
Description	Gets a `ProficiencyList` relating to the given objective. In plenary mode, the returned list contains all known proficiencies or an error results. Otherwise, the returned list may contain only those proficiencies that are accessible through this session. In effective mode, proficiencies are returned that are currently effective. In any effective mode, effective proficiencies and those currently expired are returned.
Parameters	`osid.id.Id`	`objectiveId`	an objective `Id`
Return	`osid.learning.ProficiencyList`		the returned `Proficiency` list
Errors	NULL_ARGUMENT		`objectiveId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProficienciesForObjectiveOnDate
Description	Gets a `ProficiencyList` relating to the given objective effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known proficiencies or an error results. Otherwise, the returned list may contain only those proficiencies that are accessible through this session. In effective mode, proficiencies are returned that are currently effective. In any effective mode, effective proficiencies and those currently expired are returned.
Parameters	`osid.id.Id`	`objectiveId`	an objective `Id`
	`osid.calendaring.DateTime`	`from`	starting date
	`osid.calendaring.DateTime`	`to`	ending date
Return	`osid.learning.ProficiencyList`		the returned `Proficiency` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`objectiveId, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProficienciesByGenusTypeForObjective
Description	Gets a `ProficiencyList` relating to the given objective and proficiency genus `Type.` In plenary mode, the returned list contains all known proficiencies or an error results. Otherwise, the returned list may contain only those proficiencies that are accessible through this session. In effective mode, proficiencies are returned that are currently effective. In any effective mode, effective proficiencies and those currently expired are returned.
Parameters	`osid.id.Id`	`objectiveId`	an objective `Id`
Parameters	`osid.type.Type`	`proficiencyGenusType`	a proficiency genus type
Return	`osid.learning.ProficiencyList`		the returned `Proficiency` list
Errors	NULL_ARGUMENT		`objectiveId` or `proficiencyGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProficienciesByGenusTypeForObjectiveOnDate
Description	Gets a `ProficiencyList` of the given proficiency genus type relating to the given objective effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known proficiencies or an error results. Otherwise, the returned list may contain only those proficiencies that are accessible through this session. In effective mode, proficiencies are returned that are currently effective. In any effective mode, effective proficiencies and those currently expired are returned.
Parameters	`osid.id.Id`	`objectiveId`	an objective `Id`
	`osid.type.Type`	`proficiencyGenusType`	a proficiency genus type
	`osid.calendaring.DateTime`	`from`	starting date
	`osid.calendaring.DateTime`	`to`	ending date
Return	`osid.learning.ProficiencyList`		the returned `Proficiency` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`objectiveId, proficiencyGenusType, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProficienciesForObjectives
Description	Gets a `ProficiencyList` relating to the given objectives. In plenary mode, the returned list contains all known proficiencies or an error results. Otherwise, the returned list may contain only those proficiencies that are accessible through this session. In effective mode, proficiencies are returned that are currently effective. In any effective mode, effective proficiencies and those currently expired are returned.
Parameters	`osid.id.IdList`	`objectiveIds`	the objective `Ids`
Return	`osid.learning.ProficiencyList`		the returned `Proficiency` list
Errors	NULL_ARGUMENT		`objectiveIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProficienciesForResource
Description	Gets a `ProficiencyList` relating to the given resource. In plenary mode, the returned list contains all known proficiencies or an error results. Otherwise, the returned list may contain only those proficiencies that are accessible through this session. In effective mode, proficiencies are returned that are currently effective. In any effective mode, effective proficiencies and those currently expired are returned.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Return	`osid.learning.ProficiencyList`		the returned `Proficiency` 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	getProficienciesForResourceOnDate
Description	Gets a `ProficiencyList` relating to the given resource effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known proficiencies or an error results. Otherwise, the returned list may contain only those proficiencies that are accessible through this session. In effective mode, proficiencies are returned that are currently effective. In any effective mode, effective proficiencies and those currently expired are returned.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
	`osid.calendaring.DateTime`	`from`	starting date
	`osid.calendaring.DateTime`	`to`	ending date
Return	`osid.learning.ProficiencyList`		the returned `Proficiency` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`resourceId, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProficienciesByGenusTypeForResource
Description	Gets a `ProficiencyList` relating to the given resource and proficiency genus `Type.` In plenary mode, the returned list contains all known proficiencies or an error results. Otherwise, the returned list may contain only those proficiencies that are accessible through this session. In effective mode, proficiencies are returned that are currently effective. In any effective mode, effective proficiencies and those currently expired are returned.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Parameters	`osid.type.Type`	`proficiencyGenusType`	a proficiency genus type
Return	`osid.learning.ProficiencyList`		the returned `Proficiency` list
Errors	NULL_ARGUMENT		`resourceId` or `proficiencyGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProficienciesByGenusTypeForResourceOnDate
Description	Gets a `ProficiencyList` of the given proficiency genus type relating to the given resource effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known proficiencies or an error results. Otherwise, the returned list may contain only those proficiencies that are accessible through this session. In effective mode, proficiencies are returned that are currently effective. In any effective mode, effective proficiencies and those currently expired are returned.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
	`osid.type.Type`	`proficiencyGenusType`	a proficiency genus type
	`osid.calendaring.DateTime`	`from`	starting date
	`osid.calendaring.DateTime`	`to`	ending date
Return	`osid.learning.ProficiencyList`		the returned `Proficiency` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`resourceId, proficiencyGenusType, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProficienciesForResources
Description	Gets a `ProficiencyList` relating to the given resources. In plenary mode, the returned list contains all known proficiencies or an error results. Otherwise, the returned list may contain only those proficiencies that are accessible through this session. In effective mode, proficiencies are returned that are currently effective. In any effective mode, effective proficiencies and those currently expired are returned.
Parameters	`osid.id.IdList`	`resourceIds`	the resource `Ids`
Return	`osid.learning.ProficiencyList`		the returned `Proficiency` list
Errors	NULL_ARGUMENT		`resourceIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProficienciesForObjectiveAndResource
Description	Gets a `ProficiencyList` relating to the given objective and resource `.` In plenary mode, the returned list contains all known proficiencies or an error results. Otherwise, the returned list may contain only those proficiencies that are accessible through this session. In effective mode, proficiencies are returned that are currently effective. In any effective mode, effective proficiencies and those currently expired are returned.
Parameters	`osid.id.Id`	`objectiveId`	an objective `Id`
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Return	`osid.learning.ProficiencyList`		the returned `Proficiency` list
Errors	NULL_ARGUMENT		`objectiveId` or `resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProficienciesForObjectiveAndResourceOnDate
Description	Gets a `ProficiencyList` relating to the given resource and objective effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known proficiencies or an error results. Otherwise, the returned list may contain only those proficiencies that are accessible through this session. In effective mode, proficiencies are returned that are currently effective. In any effective mode, effective proficiencies and those currently expired are returned.
Parameters	`osid.id.Id`	`objectiveId`	an objective `Id`
	`osid.id.Id`	`resourceId`	a resource `Id`
	`osid.calendaring.DateTime`	`from`	starting date
	`osid.calendaring.DateTime`	`to`	ending date
Return	`osid.learning.ProficiencyList`		the returned `Proficiency` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`objectiveId, resourceId, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProficienciesByGenusTypeForObjectiveAndResource
Description	Gets a `ProficiencyList` of the given genus type relating to the given objective and resource `.` In plenary mode, the returned list contains all known proficiencies or an error results. Otherwise, the returned list may contain only those proficiencies that are accessible through this session. In effective mode, proficiencies are returned that are currently effective. In any effective mode, effective proficiencies and those currently expired are returned.
Parameters	`osid.id.Id`	`objectiveId`	an objective `Id`
	`osid.id.Id`	`resourceId`	a resource `Id`
	`osid.type.Type`	`proficiencyGenusType`	a proficiency genus type
Return	`osid.learning.ProficiencyList`		the returned `Proficiency` list
Errors	NULL_ARGUMENT		`objectiveId, resourceId` or `proficiencyGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProficienciesByGenusTypeForObjectiveAndResourceOnDate
Description	Gets a `ProficiencyList` of the given genus type relating to the given resource and objective effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known proficiencies or an error results. Otherwise, the returned list may contain only those proficiencies that are accessible through this session. In effective mode, proficiencies are returned that are currently effective. In any effective mode, effective proficiencies and those currently expired are returned.
Parameters	`osid.id.Id`	`objectiveId`	an objective `Id`
	`osid.id.Id`	`resourceId`	a resource `Id`
	`osid.type.Type`	`proficiencyGenusType`	a proficiency genus type
	`osid.calendaring.DateTime`	`from`	starting date
	`osid.calendaring.DateTime`	`to`	ending date
Return	`osid.learning.ProficiencyList`		the returned `Proficiency` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`objectiveId, resourceId, proficiencyGenusType, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProficiencies
Description	Gets all `Proficiencies.` In plenary mode, the returned list contains all known proficiencies or an error results. Otherwise, the returned list may contain only those proficiencies that are accessible through this session. In effective mode, proficiencies are returned that are currently effective. In any effective mode, effective proficiencies and those currently expired are returned.
Return	`osid.learning.ProficiencyList`		a list of `Proficiencies`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.