public interface CompetencyLookupSession extends OsidSession
This session provides methods for retrieving premade
Competencies.
The Competency
represents a set of
efforts .
This session defines views that offer differing behaviors when retrieving multiple objects.
Competencies
with the CompetencyAdminSession.
Generally, the comparative view should be used for most applications
as it permits operation even if there is data that cannot be accessed. The
methods useFederatedFoundryView()
and
useIsolatedFoundryView()
behave as a radio group and one should be
selected before invoking the methods in this session.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupCompetencies()
Tests if this user can perform
Competency lookups. |
CompetencyList |
getCompetencies()
Gets all
Competencies. |
CompetencyList |
getCompetenciesByGenusType(Type competencyGenusType)
Gets a
CompetencyList corresponding to the given
competency genus Type which does not include
competencies of genus types derived from the specified Type. |
CompetencyList |
getCompetenciesByIds(IdList competencyIds)
Gets a
CompetencyList corresponding to the given
IdList. |
CompetencyList |
getCompetenciesByParentGenusType(Type competencyGenusType)
Gets a
CompetencyList corresponding to the given
competency genus Type and include any additional
competencies with genus types derived from the specified Type. |
CompetencyList |
getCompetenciesByRecordType(Type competencyRecordType)
Gets a
CompetencyList containing the given competency
record Type. |
Competency |
getCompetency(Id competencyId)
Gets the
Competency specified by its Id. |
Foundry |
getFoundry()
Gets the
Foundry associated with this session. |
Id |
getFoundryId()
Gets the
Foundry Id associated with this
session. |
void |
useComparativeCompetencyView()
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 |
useFederatedFoundryView()
Federates the view for methods in this session.
|
void |
useIsolatedFoundryView()
Isolates the view for methods in this session.
|
void |
usePlenaryCompetencyView()
A complete view of the
Competency returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getFoundryId()
Foundry
Id
associated with this
session. Foundry Id
associated with this sessionmandatory
- This method must be implemented. Foundry getFoundry() throws OperationFailedException, PermissionDeniedException
Foundry
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupCompetencies()
Competency
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 opt not to offer lookup operations to
unauthorized users. false
if lookup methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeCompetencyView()
mandatory
- This method is must be implemented. void usePlenaryCompetencyView()
Competency
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 useFederatedFoundryView()
mandatory
- This method is must be implemented. void useIsolatedFoundryView()
mandatory
- This method is must be implemented. Competency getCompetency(Id competencyId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Competency
specified by its Id.
In plenary mode, the exact Id
is found or a
NOT_FOUND
results. Otherwise, the returned Competency
may have a different Id
than requested, such as
the case where a duplicate Id
was assigned to a
Competency
and retained for compatibility.competencyId
- Id
of the Competency
NotFoundException
- competencyId
not
foundNullArgumentException
- competencyId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. CompetencyList getCompetenciesByIds(IdList competencyIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
CompetencyList
corresponding to the given
IdList.
In plenary mode, the returned list contains all of the
competencies 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 Competencies
may be omitted from the list
and may present the elements in any order including returning a unique
set.competencyIds
- the list of Ids
to retrieve Competency
listNotFoundException
- an Id
was not foundNullArgumentException
- competencyIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CompetencyList getCompetenciesByGenusType(Type competencyGenusType) throws OperationFailedException, PermissionDeniedException
CompetencyList
corresponding to the given
competency genus Type
which does not include
competencies of genus types derived from the specified Type.
In plenary mode, the returned list contains all known
competencies or an error results. Otherwise, the returned list may
contain only those competencies that are accessible through this
session.competencyGenusType
- a competency genus type Competency
listNullArgumentException
- competencyGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CompetencyList getCompetenciesByParentGenusType(Type competencyGenusType) throws OperationFailedException, PermissionDeniedException
CompetencyList
corresponding to the given
competency genus Type
and include any additional
competencies with genus types derived from the specified Type.
In plenary mode, the returned list contains all known
competencies or an error results. Otherwise, the returned list may
contain only those competencies that are accessible through this
session.competencyGenusType
- a competency genus type Competency
listNullArgumentException
- competencyGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CompetencyList getCompetenciesByRecordType(Type competencyRecordType) throws OperationFailedException, PermissionDeniedException
CompetencyList
containing the given competency
record Type.
In plenary mode, the returned list
contains all known competencies or an error results. Otherwise, the
returned list may contain only those competencies that are accessible
through this session.competencyRecordType
- a competency record type Competency
listNullArgumentException
- competencyRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CompetencyList getCompetencies() throws OperationFailedException, PermissionDeniedException
Competencies.
In plenary mode, the returned
list contains all known competencies or an error results. Otherwise,
the returned list may contain only those competencies that are
accessible through this session. Competencies
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.