public interface AssessmentLookupSession extends OsidSession
This session defines methods for retrieving assessments.
This lookup session defines several views:
Assessments
with the AssessmentAdminSession.
The methods useFederatedBankView()
and
useIsolatedBankView()
behave as a radio group and one should be
selected before invoking any lookup methods.
Assessments may have a record indicated by their respective types. The
record is accessed via the Assessment.
The returns may not
be cast directly from the returns in the lookup methods.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupAssessments()
Tests if this user can perform
Assessment lookups. |
Assessment |
getAssessment(Id assessmentId)
Gets the
Assessment specified by its Id. |
AssessmentList |
getAssessments()
Gets all
Assessments. |
AssessmentList |
getAssessmentsByGenusType(Type assessmentGenusType)
Gets an
AssessmentList corresponding to the given
assessment genus Type which does not include
assessments of types derived from the specified Type. |
AssessmentList |
getAssessmentsByIds(IdList assessmentIds)
Gets an
AssessmentList corresponding to the given
IdList. |
AssessmentList |
getAssessmentsByParentGenusType(Type assessmentGenusType)
Gets an
AssessmentList corresponding to the given
assessment genus Type and include any additional
assessments with genus types derived from the specified Type. |
AssessmentList |
getAssessmentsByRecordType(Type assessmentRecordType)
Gets an
AssessmentList corresponding to the given
assessment record Type. |
Bank |
getBank()
Gets the
Bank associated with this session. |
Id |
getBankId()
Gets the
Bank Id associated with this
session. |
void |
useComparativeAssessmentView()
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 |
usePlenaryAssessmentView()
A complete view of the
Assessment 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 canLookupAssessments()
Assessment
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 useComparativeAssessmentView()
mandatory
- This method is must be implemented. void usePlenaryAssessmentView()
Assessment
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. Assessment getAssessment(Id assessmentId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Assessment
specified by its Id.
In plenary mode, the exact Id
is found or a
NOT_FOUND
results. Otherwise, the returned Assessment
may have a different Id
than requested, such as
the case where a duplicate Id
was assigned to a
Assessment
and retained for compatibility.assessmentId
- Id
of the Assessment
NotFoundException
- assessmentId
not
foundNullArgumentException
- assessmentId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method is must be implemented. AssessmentList getAssessmentsByIds(IdList assessmentIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
AssessmentList
corresponding to the given
IdList.
In plenary mode, the returned list contains all
of the assessments 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 Assessments
may be omitted from
the list and may present the elements in any order including returning
a unique set.assessmentIds
- the list of Ids
to retrieve Assessment
listNotFoundException
- an Id was
not foundNullArgumentException
- assessmentIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- assessment failuremandatory
- This method must be implemented. AssessmentList getAssessmentsByGenusType(Type assessmentGenusType) throws OperationFailedException, PermissionDeniedException
AssessmentList
corresponding to the given
assessment genus Type
which does not include
assessments of types derived from the specified Type.
In plenary mode, the returned list contains all known assessments or
an error results. Otherwise, the returned list may contain only those
assessments that are accessible through this session.assessmentGenusType
- an assessment genus type Assessment
listNullArgumentException
- assessmentGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. AssessmentList getAssessmentsByParentGenusType(Type assessmentGenusType) throws OperationFailedException, PermissionDeniedException
AssessmentList
corresponding to the given
assessment genus Type
and include any additional
assessments with genus types derived from the specified Type.
In plenary mode, the returned list contains all known
assessments or an error results. Otherwise, the returned list may
contain only those assessments that are accessible through this
session.assessmentGenusType
- an assessment genus type Assessment
listNullArgumentException
- assessmentGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. AssessmentList getAssessmentsByRecordType(Type assessmentRecordType) throws OperationFailedException, PermissionDeniedException
AssessmentList
corresponding to the given
assessment record Type.
The set of assessments
implementing the given record type is returned. In plenary mode, the
returned list contains all known assessments or an error results.
Otherwise, the returned list may contain only those assessments that
are accessible through this session.assessmentRecordType
- an assessment record type Assessment
listNullArgumentException
- assessmentRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. AssessmentList getAssessments() throws OperationFailedException, PermissionDeniedException
Assessments.
In plenary mode, the returned
list contains all known assessments or an error results. Otherwise,
the returned list may contain only those assessments that are
accessible through this session. Assessments
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented.