OSID Logo
OSID Specifications
learning package
Version 3.0.0
Release Candidate Preview
Interfaceosid.learning.ProficiencyLookupSession
Implementsosid.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.

MethodgetObjectiveBankId
Description

Gets the ObjectiveBank Id associated with this session.

Returnosid.id.Idthe ObjectiveBank Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetObjectiveBank
Description

Gets the ObjectiveBank associated with this session.

Returnosid.learning.ObjectiveBankthe obective bank
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanLookupProficiencies
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.

Returnboolean false if lookup methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeProficiencyView
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.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryProficiencyView
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.

CompliancemandatoryThis method is must be implemented.
MethoduseFederatedObjectiveBankView
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.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedObjectiveBankView
Description

Isolates the view for methods in this session. An isolated view restricts retrievals to this objective bank only.

CompliancemandatoryThis method is must be implemented.
MethoduseEffectiveProficiencyView
Description

Only proficiencies whose effective dates are current are returned by methods in this session.

CompliancemandatoryThis method is must be implemented.
MethoduseAnyEffectiveProficiencyView
Description

All proficienies of any effective dates are returned by methods in this session.

CompliancemandatoryThis method is must be implemented.
MethodgetProficiency
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.

Parametersosid.id.IdproficiencyIdthe Id of the Proficiency to retrieve
Returnosid.learning.Proficiencythe returned Proficiency
ErrorsNOT_FOUNDno Proficiency found with the given Id
NULL_ARGUMENT proficiencyId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProficienciesByIds
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.

Parametersosid.id.IdListproficiencyIdsthe list of Ids to retrieve
Returnosid.learning.ProficiencyListthe returned Proficiency list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT proficiencyIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProficienciesByGenusType
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.

Parametersosid.type.TypeproficiencyGenusTypea proficiency genus type
Returnosid.learning.ProficiencyListthe returned Proficiency list
ErrorsNULL_ARGUMENT proficiencyGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProficienciesByParentGenusType
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.

Parametersosid.type.TypeproficiencyGenusTypea proficiency genus type
Returnosid.learning.ProficiencyListthe returned Proficiency list
ErrorsNULL_ARGUMENT proficiencyGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProficienciesByRecordType
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.

Parametersosid.type.TypeproficiencyRecordTypea proficiency record type
Returnosid.learning.ProficiencyListthe returned Proficiency list
ErrorsNULL_ARGUMENT proficiencyRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProficienciesOnDate
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.

Parametersosid.calendaring.DateTimefromstarting date
osid.calendaring.DateTimetoending date
Returnosid.learning.ProficiencyListthe returned Proficiency list
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT from or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProficienciesByGenusTypeOnDate
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.

Parametersosid.type.TypeproficiencyGenusTypea proficiency genus type
osid.calendaring.DateTimefromstarting date
osid.calendaring.DateTimetoending date
Returnosid.learning.ProficiencyListthe returned Proficiency list
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT proficiencyGenusType, from, or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProficienciesForObjective
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.

Parametersosid.id.IdobjectiveIdan objective Id
Returnosid.learning.ProficiencyListthe returned Proficiency list
ErrorsNULL_ARGUMENT objectiveId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProficienciesForObjectiveOnDate
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.

Parametersosid.id.IdobjectiveIdan objective Id
osid.calendaring.DateTimefromstarting date
osid.calendaring.DateTimetoending date
Returnosid.learning.ProficiencyListthe returned Proficiency list
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT objectiveId, from or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProficienciesByGenusTypeForObjective
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.

Parametersosid.id.IdobjectiveIdan objective Id
osid.type.TypeproficiencyGenusTypea proficiency genus type
Returnosid.learning.ProficiencyListthe returned Proficiency list
ErrorsNULL_ARGUMENT objectiveId or proficiencyGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProficienciesByGenusTypeForObjectiveOnDate
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.

Parametersosid.id.IdobjectiveIdan objective Id
osid.type.TypeproficiencyGenusTypea proficiency genus type
osid.calendaring.DateTimefromstarting date
osid.calendaring.DateTimetoending date
Returnosid.learning.ProficiencyListthe returned Proficiency list
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT objectiveId, proficiencyGenusType, from, or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProficienciesForObjectives
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.

Parametersosid.id.IdListobjectiveIdsthe objective Ids
Returnosid.learning.ProficiencyListthe returned Proficiency list
ErrorsNULL_ARGUMENT objectiveIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProficienciesForResource
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.

Parametersosid.id.IdresourceIda resource Id
Returnosid.learning.ProficiencyListthe returned Proficiency list
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProficienciesForResourceOnDate
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.

Parametersosid.id.IdresourceIda resource Id
osid.calendaring.DateTimefromstarting date
osid.calendaring.DateTimetoending date
Returnosid.learning.ProficiencyListthe returned Proficiency list
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT resourceId, from or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProficienciesByGenusTypeForResource
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.

Parametersosid.id.IdresourceIda resource Id
osid.type.TypeproficiencyGenusTypea proficiency genus type
Returnosid.learning.ProficiencyListthe returned Proficiency list
ErrorsNULL_ARGUMENT resourceId or proficiencyGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProficienciesByGenusTypeForResourceOnDate
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.

Parametersosid.id.IdresourceIda resource Id
osid.type.TypeproficiencyGenusTypea proficiency genus type
osid.calendaring.DateTimefromstarting date
osid.calendaring.DateTimetoending date
Returnosid.learning.ProficiencyListthe returned Proficiency list
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT resourceId, proficiencyGenusType, from or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProficienciesForResources
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.

Parametersosid.id.IdListresourceIdsthe resource Ids
Returnosid.learning.ProficiencyListthe returned Proficiency list
ErrorsNULL_ARGUMENT resourceIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProficienciesForObjectiveAndResource
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.

Parametersosid.id.IdobjectiveIdan objective Id
osid.id.IdresourceIda resource Id
Returnosid.learning.ProficiencyListthe returned Proficiency list
ErrorsNULL_ARGUMENT objectiveId or resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProficienciesForObjectiveAndResourceOnDate
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.

Parametersosid.id.IdobjectiveIdan objective Id
osid.id.IdresourceIda resource Id
osid.calendaring.DateTimefromstarting date
osid.calendaring.DateTimetoending date
Returnosid.learning.ProficiencyListthe returned Proficiency list
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT objectiveId, resourceId, from or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProficienciesByGenusTypeForObjectiveAndResource
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.

Parametersosid.id.IdobjectiveIdan objective Id
osid.id.IdresourceIda resource Id
osid.type.TypeproficiencyGenusTypea proficiency genus type
Returnosid.learning.ProficiencyListthe returned Proficiency list
ErrorsNULL_ARGUMENT objectiveId, resourceId or proficiencyGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProficienciesByGenusTypeForObjectiveAndResourceOnDate
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.

Parametersosid.id.IdobjectiveIdan objective Id
osid.id.IdresourceIda resource Id
osid.type.TypeproficiencyGenusTypea proficiency genus type
osid.calendaring.DateTimefromstarting date
osid.calendaring.DateTimetoending date
Returnosid.learning.ProficiencyListthe returned Proficiency list
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT objectiveId, resourceId, proficiencyGenusType, from or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProficiencies
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.

Returnosid.learning.ProficiencyLista list of Proficiencies
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.