public interface AssessmentPartItemSession extends OsidSession
This session defines methods for looking up Item
to
AssessmentPart
mappings.
This lookup session defines several views:
The methods useFederatedAssessmentPartView()
and
useIsolatedAssessmentPartView()
behave as a radio group and one
should be selected before invoking any lookup methods.
Modifier and Type | Method and Description |
---|---|
boolean |
canAccessAssessmentPartItems()
Tests if this user can perform assessment part lookups.
|
ItemList |
getAssessmentPartItems(Id assessmentPartId)
Gets the list of items mapped to the given
AssessmentPart. |
AssessmentPartList |
getAssessmentPartsByItem(Id itemId)
Gets the assessment parts containing the given item.
|
Bank |
getBank()
Gets the
Bank associated with this session. |
Id |
getBankId()
Gets the
Bank Id associated with this
session. |
void |
useComparativeAsseessmentPartItemView()
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 |
useFederatedBankView()
Federates the view for methods in this session.
|
void |
useIsolatedBankView()
Isolates the view for methods in this session.
|
void |
usePlenaryAssessmentPartItemView()
A complete view of the 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 canAccessAssessmentPartItems()
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 useComparativeAsseessmentPartItemView()
mandatory
- This method is must be implemented. void usePlenaryAssessmentPartItemView()
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. ItemList getAssessmentPartItems(Id assessmentPartId) throws NotFoundException, OperationFailedException, PermissionDeniedException
AssessmentPart.
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.assessmentPartId
- Id
of the
AssessmentPart
NotFoundException
- assessmentPartId
not
foundNullArgumentException
- assessmentPartId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. AssessmentPartList getAssessmentPartsByItem(Id itemId) throws NotFoundException, OperationFailedException, PermissionDeniedException
itemId
- Id
of the Item
AssessmentPart list
NotFoundException
- itemId
is not foundNullArgumentException
- itemId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.