public interface ProficiencyLookupSession extends OsidSession
This session defines methods for retrieving proficiencies.
This lookup session defines several views:
Proficiencies
with the
ProficiencyAdminSession.
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.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupProficiencies()
Tests if this user can perform
Proficiency lookups. |
ObjectiveBank |
getObjectiveBank()
Gets the
ObjectiveBank associated with this session. |
Id |
getObjectiveBankId()
Gets the
ObjectiveBank Id associated
with this session. |
ProficiencyList |
getProficiencies()
Gets all
Proficiencies. |
ProficiencyList |
getProficienciesByGenusType(Type proficiencyGenusType)
Gets a
ProficiencyList corresponding to the given
proficiency genus Type which does not include
proficiencies of types derived from the specified Type. |
ProficiencyList |
getProficienciesByGenusTypeForObjective(Id objectiveId,
Type proficiencyGenusType)
Gets a
ProficiencyList relating to the given objective
and proficiency genus Type. |
ProficiencyList |
getProficienciesByGenusTypeForObjectiveAndResource(Id objectiveId,
Id resourceId,
Type proficiencyGenusType)
Gets a
ProficiencyList of the given genus type relating
to the given objective and resource . |
ProficiencyList |
getProficienciesByGenusTypeForObjectiveAndResourceOnDate(Id objectiveId,
Id resourceId,
Type proficiencyGenusType,
DateTime from,
DateTime to)
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. |
ProficiencyList |
getProficienciesByGenusTypeForObjectiveOnDate(Id objectiveId,
Type proficiencyGenusType,
DateTime from,
DateTime to)
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. |
ProficiencyList |
getProficienciesByGenusTypeForResource(Id resourceId,
Type proficiencyGenusType)
Gets a
ProficiencyList relating to the given resource
and proficiency genus Type. |
ProficiencyList |
getProficienciesByGenusTypeForResourceOnDate(Id resourceId,
Type proficiencyGenusType,
DateTime from,
DateTime to)
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. |
ProficiencyList |
getProficienciesByGenusTypeOnDate(Type proficiencyGenusType,
DateTime from,
DateTime to)
Gets a
ProficiencyList of the given proficiency genus
type effective during the entire given date range inclusive but not
confined to the date range. |
ProficiencyList |
getProficienciesByIds(IdList proficiencyIds)
Gets a
ProficiencyList corresponding to the given
IdList. |
ProficiencyList |
getProficienciesByParentGenusType(Type proficiencyGenusType)
Gets a
ProficiencyList corresponding to the given
proficiency genus Type and include any additional
proficiencies with genus types derived from the specified Type. |
ProficiencyList |
getProficienciesByRecordType(Type proficiencyRecordType)
Gets a
ProficiencyList containing the given proficiency
record Type. |
ProficiencyList |
getProficienciesForObjective(Id objectiveId)
Gets a
ProficiencyList relating to the given objective. |
ProficiencyList |
getProficienciesForObjectiveAndResource(Id objectiveId,
Id resourceId)
Gets a
ProficiencyList relating to the given objective
and resource . |
ProficiencyList |
getProficienciesForObjectiveAndResourceOnDate(Id objectiveId,
Id resourceId,
DateTime from,
DateTime to)
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. |
ProficiencyList |
getProficienciesForObjectiveOnDate(Id objectiveId,
DateTime from,
DateTime to)
Gets a
ProficiencyList relating to the given objective
effective during the entire given date range inclusive but not
confined to the date range. |
ProficiencyList |
getProficienciesForObjectives(IdList objectiveIds)
Gets a
ProficiencyList relating to the given
objectives. |
ProficiencyList |
getProficienciesForResource(Id resourceId)
Gets a
ProficiencyList relating to the given resource. |
ProficiencyList |
getProficienciesForResourceOnDate(Id resourceId,
DateTime from,
DateTime to)
Gets a
ProficiencyList relating to the given resource
effective during the entire given date range inclusive but not
confined to the date range. |
ProficiencyList |
getProficienciesForResources(IdList resourceIds)
Gets a
ProficiencyList relating to the given resources. |
ProficiencyList |
getProficienciesOnDate(DateTime from,
DateTime to)
Gets a
ProficiencyList effecyive during the entire
given date range inclusive but not confined to the date range. |
Proficiency |
getProficiency(Id proficiencyId)
Gets the
Proficiency specified by its Id. |
void |
useAnyEffectiveProficiencyView()
All proficienies of any effective dates are returned by methods in
this session.
|
void |
useComparativeProficiencyView()
The returns from the lookup methods may omit or translate elements
based on this session, such as authorization, and not result in an
error.
|
void |
useEffectiveProficiencyView()
Only proficiencies whose effective dates are current are returned by
methods in this session.
|
void |
useFederatedObjectiveBankView()
Federates the view for methods in this session.
|
void |
useIsolatedObjectiveBankView()
Isolates the view for methods in this session.
|
void |
usePlenaryProficiencyView()
A complete view of the
Proficiency returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getObjectiveBankId()
ObjectiveBank
Id
associated
with this session. ObjectiveBank Id
associated with this
sessionmandatory
- This method must be implemented. ObjectiveBank getObjectiveBank() throws OperationFailedException, PermissionDeniedException
ObjectiveBank
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupProficiencies()
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. false
if lookup methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeProficiencyView()
mandatory
- This method is must be implemented. void usePlenaryProficiencyView()
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.mandatory
- This method is must be implemented. void useFederatedObjectiveBankView()
mandatory
- This method is must be implemented. void useIsolatedObjectiveBankView()
mandatory
- This method is must be implemented. void useEffectiveProficiencyView()
mandatory
- This method is must be implemented. void useAnyEffectiveProficiencyView()
mandatory
- This method is must be implemented. Proficiency getProficiency(Id proficiencyId) throws NotFoundException, OperationFailedException, PermissionDeniedException
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.proficiencyId
- the Id
of the Proficiency
to retrieve Proficiency
NotFoundException
- no Proficiency
found
with the given Id
NullArgumentException
- proficiencyId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProficiencyList getProficienciesByIds(IdList proficiencyIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
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.proficiencyIds
- the list of Ids
to retrieve Proficiency
listNotFoundException
- an Id
was not foundNullArgumentException
- proficiencyIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProficiencyList getProficienciesByGenusType(Type proficiencyGenusType) throws OperationFailedException, PermissionDeniedException
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.proficiencyGenusType
- a proficiency genus type Proficiency
listNullArgumentException
- proficiencyGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProficiencyList getProficienciesByParentGenusType(Type proficiencyGenusType) throws OperationFailedException, PermissionDeniedException
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.proficiencyGenusType
- a proficiency genus type Proficiency
listNullArgumentException
- proficiencyGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProficiencyList getProficienciesByRecordType(Type proficiencyRecordType) throws OperationFailedException, PermissionDeniedException
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.proficiencyRecordType
- a proficiency record type Proficiency
listNullArgumentException
- proficiencyRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProficiencyList getProficienciesOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
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.from
- starting dateto
- ending date Proficiency
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- from
or
to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProficiencyList getProficienciesByGenusTypeOnDate(Type proficiencyGenusType, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
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.proficiencyGenusType
- a proficiency genus typefrom
- starting dateto
- ending date Proficiency
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- proficiencyGenusType,
from,
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProficiencyList getProficienciesForObjective(Id objectiveId) throws OperationFailedException, PermissionDeniedException
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.objectiveId
- an objective Id
Proficiency
listNullArgumentException
- objectiveId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProficiencyList getProficienciesForObjectiveOnDate(Id objectiveId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
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.objectiveId
- an objective Id
from
- starting dateto
- ending date Proficiency
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- objectiveId, from
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProficiencyList getProficienciesByGenusTypeForObjective(Id objectiveId, Type proficiencyGenusType) throws OperationFailedException, PermissionDeniedException
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.objectiveId
- an objective Id
proficiencyGenusType
- a proficiency genus type Proficiency
listNullArgumentException
- objectiveId
or
proficiencyGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProficiencyList getProficienciesByGenusTypeForObjectiveOnDate(Id objectiveId, Type proficiencyGenusType, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
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.objectiveId
- an objective Id
proficiencyGenusType
- a proficiency genus typefrom
- starting dateto
- ending date Proficiency
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- objectiveId,
proficiencyGenusType, from,
or to
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProficiencyList getProficienciesForObjectives(IdList objectiveIds) throws OperationFailedException, PermissionDeniedException
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.objectiveIds
- the objective Ids
Proficiency
listNullArgumentException
- objectiveIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProficiencyList getProficienciesForResource(Id resourceId) throws OperationFailedException, PermissionDeniedException
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.resourceId
- a resource Id
Proficiency
listNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProficiencyList getProficienciesForResourceOnDate(Id resourceId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
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.resourceId
- a resource Id
from
- starting dateto
- ending date Proficiency
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- resourceId, from
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProficiencyList getProficienciesByGenusTypeForResource(Id resourceId, Type proficiencyGenusType) throws OperationFailedException, PermissionDeniedException
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.resourceId
- a resource Id
proficiencyGenusType
- a proficiency genus type Proficiency
listNullArgumentException
- resourceId
or
proficiencyGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProficiencyList getProficienciesByGenusTypeForResourceOnDate(Id resourceId, Type proficiencyGenusType, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
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.resourceId
- a resource Id
proficiencyGenusType
- a proficiency genus typefrom
- starting dateto
- ending date Proficiency
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- resourceId,
proficiencyGenusType, from
or to
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProficiencyList getProficienciesForResources(IdList resourceIds) throws OperationFailedException, PermissionDeniedException
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.resourceIds
- the resource Ids
Proficiency
listNullArgumentException
- resourceIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProficiencyList getProficienciesForObjectiveAndResource(Id objectiveId, Id resourceId) throws OperationFailedException, PermissionDeniedException
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.objectiveId
- an objective Id
resourceId
- a resource Id
Proficiency
listNullArgumentException
- objectiveId
or
resourceId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProficiencyList getProficienciesForObjectiveAndResourceOnDate(Id objectiveId, Id resourceId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
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.objectiveId
- an objective Id
resourceId
- a resource Id
from
- starting dateto
- ending date Proficiency
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- objectiveId, resourceId,
from
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProficiencyList getProficienciesByGenusTypeForObjectiveAndResource(Id objectiveId, Id resourceId, Type proficiencyGenusType) throws OperationFailedException, PermissionDeniedException
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.objectiveId
- an objective Id
resourceId
- a resource Id
proficiencyGenusType
- a proficiency genus type Proficiency
listNullArgumentException
- objectiveId, resourceId
or proficiencyGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProficiencyList getProficienciesByGenusTypeForObjectiveAndResourceOnDate(Id objectiveId, Id resourceId, Type proficiencyGenusType, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
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.objectiveId
- an objective Id
resourceId
- a resource Id
proficiencyGenusType
- a proficiency genus typefrom
- starting dateto
- ending date Proficiency
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- objectiveId, resourceId,
proficiencyGenusType, from
or to
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProficiencyList getProficiencies() throws OperationFailedException, PermissionDeniedException
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. Proficiencies
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.