public interface AssessmentPartLookupSession extends OsidSession
This session defines methods for retrieving assessment parts.
This lookup session defines several views:
The methods useFederatedBankView()
and
useIsolatedBankView()
behave as a radio group and one should be
selected before invoking any lookup methods.
Assessment parts may have an additional records indicated by their
respective record types. The record may not be accessed through a cast of
the AssessmentPart.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupAssessmentParts()
Tests if this user can perform
AssessmentPart lookups. |
AssessmentPart |
getAssessmentPart(Id assessmentPartId)
Gets the
AssessmentPart specified by its Id. |
AssessmentPartList |
getAssessmentParts()
Gets all
AssessmentParts. |
AssessmentPartList |
getAssessmentPartsByGenusType(Type assessmentPartGenusType)
Gets an
AssessmentPartList corresponding to the given
assessment part genus Type which does not include
assessment parts of types derived from the specified Type. |
AssessmentPartList |
getAssessmentPartsByIds(IdList assessmentPartIds)
Gets an
AssessmentPartList corresponding to the given
IdList. |
AssessmentPartList |
getAssessmentPartsByParentGenusType(Type assessmentGenusType)
Gets an
AssessmentPartList corresponding to the given
assessment part genus Type and include any additional
assessment parts with genus types derived from the specified
Type. |
AssessmentPartList |
getAssessmentPartsByRecordType(Type assessmentPartRecordType)
Gets an
AssessmentPart containing the given assessment
part record Type. |
AssessmentPartList |
getAssessmentPartsForAssessment(Id assessmentId)
Gets an
AssessmentPart for the given assessment. |
Bank |
getBank()
Gets the
Bank associated with this session. |
Id |
getBankId()
Gets the
Bank Id associated with this
session. |
void |
useActiveAssessmentPartView()
Only active assessment parts are returned by methods in this session.
|
void |
useAnyStatusAssessmentPartView()
All active and inactive assessment parts are returned by methods in
this session.
|
void |
useComparativeAssessmentPartView()
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 |
usePlenaryAssessmentPartView()
A complete view of the
AssessmentPart returns is
desired. |
void |
useSequesteredAssessmentPartView()
The methods in this session omit sequestered assessment parts.
|
void |
useUnsequesteredAssessmentPartView()
The methods in this session return all assessment parts, including
sequestered assessment parts.
|
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 canLookupAssessmentParts()
AssessmentPart
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 useComparativeAssessmentPartView()
mandatory
- This method is must be implemented. void usePlenaryAssessmentPartView()
AssessmentPart
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. void useActiveAssessmentPartView()
mandatory
- This method is must be implemented. void useAnyStatusAssessmentPartView()
mandatory
- This method is must be implemented. void useSequesteredAssessmentPartView()
mandatory
- This method is must be implemented. void useUnsequesteredAssessmentPartView()
mandatory
- This method is must be implemented. AssessmentPart getAssessmentPart(Id assessmentPartId) throws NotFoundException, OperationFailedException, PermissionDeniedException
AssessmentPart
specified by its Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
AssessmentPart
may have a different Id
than
requested, such as the case where a duplicate Id
was
assigned to an AssessmentPart
and retained for
compatibility.
In active mode, assessment parts are returned that are currently
active. In any effective mode, active and inactive assessment parts
are returned.
In sequestered mode, no sequestered assessment parts are returned. In
unsequestered mode, all assessment parts are returned.assessmentPartId
- the Id
of the
AssessmentPart
to retrieve AssessmentPart
NotFoundException
- no AssessmentPart
found with the given Id
NullArgumentException
- assessmentPartId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AssessmentPartList getAssessmentPartsByIds(IdList assessmentPartIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
AssessmentPartList
corresponding to the given
IdList.
In plenary mode, the returned list contains all of the
assessment parts 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 AssessmentParts
may be omitted from the
list and may present the elements in any order including returning a
unique set.
In active mode, assessment parts are returned that are currently
active. In any effective mode, active and inactive assessment parts
are returned.
In sequestered mode, no sequestered assessment parts are returned. In
unsequestered mode, all assessment parts are returned.assessmentPartIds
- the list of Ids
to retrieve AssessmentPart
listNotFoundException
- an Id was
not foundNullArgumentException
- assessmentPartIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AssessmentPartList getAssessmentPartsByGenusType(Type assessmentPartGenusType) throws OperationFailedException, PermissionDeniedException
AssessmentPartList
corresponding to the given
assessment part genus Type
which does not include
assessment parts of types derived from the specified Type.
In plenary mode, the returned list contains all known
assessment parts or an error results. Otherwise, the returned list may
contain only those assessment parts that are accessible through this
session.
In active mode, assessment parts are returned that are currently
active. In any effective mode, active and inactive assessment parts
are returned.
In sequestered mode, no sequestered assessment parts are returned. In
unsequestered mode, all assessment parts are returned.assessmentPartGenusType
- an assessment part genus type AssessmentPart
listNullArgumentException
- assessmentPartGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AssessmentPartList getAssessmentPartsByParentGenusType(Type assessmentGenusType) throws OperationFailedException, PermissionDeniedException
AssessmentPartList
corresponding to the given
assessment part genus Type
and include any additional
assessment parts with genus types derived from the specified
Type.
In plenary mode, the returned list contains all known
assessment parts or an error results. Otherwise, the returned list may
contain only those assessment parts that are accessible through this
session.
In active mode, assessment parts are returned that are currently
active. In any effective mode, active and inactive assessment parts
are returned.
In sequestered mode, no sequestered assessment parts are returned. In
unsequestered mode, all assessment parts are returned.assessmentGenusType
- an assessment part genus type AssessmentPart
listNullArgumentException
- assessmentPartGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AssessmentPartList getAssessmentPartsByRecordType(Type assessmentPartRecordType) throws OperationFailedException, PermissionDeniedException
AssessmentPart
containing the given assessment
part record Type.
In plenary mode, the returned list contains all known assessment parts
or an error results. Otherwise, the returned list may contain only
those assessment parts that are accessible through this session.
In active mode, assessment parts are returned that are currently
active. In any effective mode, active and inactive assessment parts
are returned.
In sequestered mode, no sequestered assessment parts are returned. In
unsequestered mode, all assessment parts are returned.assessmentPartRecordType
- an assessment part record type AssessmentPart
listNullArgumentException
- assessmentPartRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AssessmentPartList getAssessmentPartsForAssessment(Id assessmentId) throws OperationFailedException, PermissionDeniedException
AssessmentPart
for the given assessment.
In plenary mode, the returned list contains all known assessment parts
or an error results. Otherwise, the returned list may contain only
those assessment parts that are accessible through this session.
In active mode, assessment parts are returned that are currently
active. In any effective mode, active and inactive assessment parts
are returned.
In sequestered mode, no sequestered assessment parts are returned. In
unsequestered mode, all assessment parts are returned.assessmentId
- an assessment Id
AssessmentPart
listNullArgumentException
- assessmentId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AssessmentPartList getAssessmentParts() throws OperationFailedException, PermissionDeniedException
AssessmentParts.
In plenary mode, the returned list contains all known assessment parts
or an error results. Otherwise, the returned list may contain only
those assessment parts that are accessible through this session.
In active mode, assessment parts are returned that are currently
active. In any effective mode, active and inactive assessment parts
are returned.
In sequestered mode, no sequestered assessment parts are returned. In
unsequestered mode, all assessment parts are returned. AssessmentParts
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.