public interface ObjectiveLookupSession extends OsidSession
This session provides methods for retrieving Objective
s.
This session defines views that offer differing behaviors when retrieving multiple objects.
ObjectiveAdminSession.
Objectives may have an additional records indicated by their
respective record types. The record may not be accessed through a cast of
the Objective.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupObjectives()
Tests if this user can perform
Objective lookups. |
Objective |
getObjective(Id objectiveId)
Gets the
Objective specified by its Id. |
ObjectiveBank |
getObjectiveBank()
Gets the
ObjectiveBank associated with this session. |
Id |
getObjectiveBankId()
Gets the
ObjectiveBank Id associated
with this session. |
ObjectiveList |
getObjectives()
Gets all
Objectives. |
ObjectiveList |
getObjectivesByGenusType(Type objectiveGenusType)
Gets an
ObjectiveList corresponding to the given
objective genus Type which does not include objectives
of genus types derived from the specified Type. |
ObjectiveList |
getObjectivesByIds(IdList objectiveIds)
Gets an
ObjectiveList corresponding to the given
IdList. |
ObjectiveList |
getObjectivesByParentGenusType(Type objectiveGenusType)
Gets an
ObjectiveList corresponding to the given
objective genus Type and include any additional
objective with genus types derived from the specified Type. |
ObjectiveList |
getObjectivesByRecordType(Type objectiveRecordType)
Gets an
ObjectiveList containing the given objective
record Type. |
void |
useComparativeObjectiveView()
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 |
useFederatedObjectiveBankView()
Federates the view for methods in this session.
|
void |
useIsolatedObjectiveBankView()
Isolates the view for methods in this session.
|
void |
usePlenaryObjectiveView()
A complete view of the
Objective 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. ObjectiveBank
associated with this sessionOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupObjectives()
Objective
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 useComparativeObjectiveView()
mandatory
- This method is must be implemented. void usePlenaryObjectiveView()
Objective
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. Objective getObjective(Id objectiveId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Objective
specified by its Id.
In plenary mode, the exact Id
is found or a
NOT_FOUND
results. Otherwise, the returned Objective
may have a different Id
than requested, such as
the case where a duplicate Id
was assigned to an
Objective
and retained for compatibility.objectiveId
- Id
of the Objective
NotFoundException
- objectiveId
not
foundNullArgumentException
- objectiveId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. ObjectiveList getObjectivesByIds(IdList objectiveIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
ObjectiveList
corresponding to the given
IdList.
In plenary mode, the returned list contains all of the
objectives 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 Objectives
may be omitted from the list
and may present the elements in any order including returning a unique
set.objectiveIds
- the list of Ids
to retrieve Objective
listNotFoundException
- an Id was
not foundNullArgumentException
- objectiveIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ObjectiveList getObjectivesByGenusType(Type objectiveGenusType) throws OperationFailedException, PermissionDeniedException
ObjectiveList
corresponding to the given
objective genus Type
which does not include objectives
of genus types derived from the specified Type.
In
plenary mode, the returned list contains all known objectives or an
error results. Otherwise, the returned list may contain only those
objectives that are accessible through this session.objectiveGenusType
- an objective genus type Objective
listNullArgumentException
- objectiveGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ObjectiveList getObjectivesByParentGenusType(Type objectiveGenusType) throws OperationFailedException, PermissionDeniedException
ObjectiveList
corresponding to the given
objective genus Type
and include any additional
objective with genus types derived from the specified Type.
In plenary mode, the returned list contains all known
objectives or an error results. Otherwise, the returned list may
contain only those objectives that are accessible through this sessionobjectiveGenusType
- an objective genus type Objective
listNullArgumentException
- objectiveGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ObjectiveList getObjectivesByRecordType(Type objectiveRecordType) throws OperationFailedException, PermissionDeniedException
ObjectiveList
containing the given objective
record Type.
In plenary mode, the returned list
contains all known objectives or an error results. Otherwise, the
returned list may contain only those objectives that are accessible
through this session.objectiveRecordType
- an objective record type Objective
listNullArgumentException
- objectiveRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ObjectiveList getObjectives() throws OperationFailedException, PermissionDeniedException
Objectives.
In plenary mode, the returned list
contains all known objectives or an error results. Otherwise, the
returned list may contain only those objectives that are accessible
through this session. ObjectiveList
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.