public interface ItemLookupSession extends OsidSession
This session provides methods for retrieving Item
objects.
This session defines two sets of views which offer differing behaviors when retrieving multiple objects.
ItemAdminSession.
Generally, the comparative view should be used for most applications as it permits operation even if there a particular element is inaccessible. For example, a hierarchy output can be plugged into a lookup method to retrieve all objects known to a hierarchy, but it may not be necessary to break execution if a node from the hierarchy no longer exists. However, some administrative applications may need to know whether it had retrieved an entire set of objects and may sacrifice some interoperability for the sake of precision.
Items may have an additional records indicated by their respective record types.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupItems()
Tests if this user can perform
Item lookups. |
Bank |
getBank()
Gets the
Bank associated with this session. |
Id |
getBankId()
Gets the
Bank Id associated with this
session. |
Item |
getItem(Id itemId)
Gets the
Item specified by its Id. |
ItemList |
getItems()
Gets all
Items. |
ItemList |
getItemsByAnswer(Id answerId)
Gets an
ItemList containing the given answer. |
ItemList |
getItemsByGenusType(Type itemGenusType)
Gets an
ItemList corresponding to the given assessment
item genus Type which does not include assessment items
of genus types derived from the specified Type. |
ItemList |
getItemsByIds(IdList itemIds)
Gets an
ItemList corresponding to the given
IdList. |
ItemList |
getItemsByLearningObjective(Id objectiveId)
Gets an
ItemList containing the given learning
objective. |
ItemList |
getItemsByLearningObjectives(IdList objectiveIds)
Gets an
ItemList containing the given learning
objectives. |
ItemList |
getItemsByParentGenusType(Type itemGenusType)
Gets an
ItemList corresponding to the given assessment
item genus Type and include any additional assessment
items with genus types derived from the specified Type. |
ItemList |
getItemsByQuestion(Id questionId)
Gets an
ItemList containing the given question. |
ItemList |
getItemsByRecordType(Type itemRecordType)
Gets an
ItemList containing the given assessment item
record Type. |
void |
useComparativeItemView()
The returns from the lookup methods may omit or translate elements
based on this session, such as assessment, and not result in an error.
|
void |
useFederatedBankView()
Federates the view for methods in this session.
|
void |
useIsolatedBankView()
Isolates the view for methods in this session.
|
void |
usePlenaryItemView()
A complete view of the
Item returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getBankId()
Bank
Id
associated with this
session. Bank Id
associated with this sessionmandatory
- This method must be implemented. Bank getBank() throws OperationFailedException, PermissionDeniedException
Bank
associated with this session. Bank
associated with this sessionOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupItems()
Item
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. false
if lookup methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeItemView()
mandatory
- This method is must be implemented. void usePlenaryItemView()
Item
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 useFederatedBankView()
mandatory
- This method is must be implemented. void useIsolatedBankView()
mandatory
- This method is must be implemented. Item getItem(Id itemId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Item
specified by its Id.
In
plenary mode, the exact Id
is found or a
NOT_FOUND
results. Otherwise, the returned Item
may have a different Id
than requested, such as the
case where a duplicate Id
was assigned to an
Item
and retained for compatibility.itemId
- the Id
of the Item
to
retrieve Item
NotFoundException
- no Item
found with
the given Id
NullArgumentException
- itemId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. ItemList getItemsByIds(IdList itemIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
ItemList
corresponding to the given
IdList.
In plenary mode, the returned list contains all of the
items 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 Items
may be omitted from the list and may
present the elements in any order including returning a unique set.itemIds
- the list of Ids
to retrieve Item
listNotFoundException
- an Id was
not foundNullArgumentException
- itemIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. ItemList getItemsByGenusType(Type itemGenusType) throws OperationFailedException, PermissionDeniedException
ItemList
corresponding to the given assessment
item genus Type
which does not include assessment items
of genus types derived from the specified Type.
In
plenary mode, the returned list contains all known assessment items or
an error results. Otherwise, the returned list may contain only those
assessment items that are accessible through this session.itemGenusType
- an assessment item genus type Item
listNullArgumentException
- itemGenusType
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. ItemList getItemsByParentGenusType(Type itemGenusType) throws OperationFailedException, PermissionDeniedException
ItemList
corresponding to the given assessment
item genus Type
and include any additional assessment
items with genus types derived from the specified Type.
In plenary mode, the returned list contains all known assessment items
or an error results. Otherwise, the returned list may contain only
those assessment items that are accessible through this session.itemGenusType
- an assessment item genus type Item
listNullArgumentException
- itemGenusType
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. ItemList getItemsByRecordType(Type itemRecordType) throws OperationFailedException, PermissionDeniedException
ItemList
containing the given assessment item
record Type.
In plenary mode, the returned list
contains all known items or an error results. Otherwise, the returned
list may contain only those assessment items that are accessible
through this session.itemRecordType
- an item record type Item
listNullArgumentException
- itemRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. ItemList getItemsByQuestion(Id questionId) throws OperationFailedException, PermissionDeniedException
ItemList
containing the given question.
In plenary mode, the returned list contains all known items or
an error results. Otherwise, the returned list may contain only those
assessment items that are accessible through this session.questionId
- a question Id
Item
listNullArgumentException
- questionId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. ItemList getItemsByAnswer(Id answerId) throws OperationFailedException, PermissionDeniedException
ItemList
containing the given answer.
In plenary mode, the returned list contains all known items or
an error results. Otherwise, the returned list may contain only those
assessment items that are accessible through this session.answerId
- an answer Id
Item
listNullArgumentException
- answerId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. ItemList getItemsByLearningObjective(Id objectiveId) throws OperationFailedException, PermissionDeniedException
ItemList
containing the given learning
objective.
In plenary mode, the returned list contains
all known items or an error results. Otherwise, the returned list may
contain only those assessment items that are accessible through this
session.objectiveId
- a learning objective Id
Item
listNullArgumentException
- objectiveId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. ItemList getItemsByLearningObjectives(IdList objectiveIds) throws OperationFailedException, PermissionDeniedException
ItemList
containing the given learning
objectives.
In plenary mode, the returned list contains
all known items or an error results. Otherwise, the returned list may
contain only those assessment items that are accessible through this
session.objectiveIds
- a list of learning objective Ids
Item
listNullArgumentException
- objectiveIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. ItemList getItems() throws OperationFailedException, PermissionDeniedException
Items.
In plenary mode, the returned list
contains all known items or an error results. Otherwise, the returned
list may contain only those items that are accessible through this
session. Items
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented.