public interface AssessmentOfferedLookupSession extends OsidSession
This session defines methods for retrieving assessments offered.
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 offered may have a record indicated by their respective
types. The record is accessed via the AssessmentOffered.
The returns may not be cast directly from the returns in the lookup
methods.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupAssessmentsOffered()
Tests if this user can perform
AssessmentOffered
lookups. |
AssessmentOffered |
getAssessmentOffered(Id assessmentOfferedId)
Gets the
AssessmentOffered specified by its Id. |
AssessmentOfferedList |
getAssessmentsOffered()
Gets all
AssessmentOffered elements. |
AssessmentOfferedList |
getAssessmentsOfferedByDate(DateTime start,
DateTime end)
Gets an
AssessmentOfferedList that have designated
start times where the start times fall in the given range inclusive. |
AssessmentOfferedList |
getAssessmentsOfferedByGenusType(Type assessmentOfferedGenusType)
Gets an
AssessmentOfferedList corresponding to the
given assessment offered genus Type which does not
include assessments of types derived from the specified Type. |
AssessmentOfferedList |
getAssessmentsOfferedByIds(IdList assessmentOfferedIds)
Gets an
AssessmentOfferedList corresponding to the
given IdList. |
AssessmentOfferedList |
getAssessmentsOfferedByParentGenusType(Type assessmentOfferedGenusType)
Gets an
AssessmentOfferedList corresponding to the
given assessment offered genus Type and include any
additional assessments with genus types derived from the specified
Type. |
AssessmentOfferedList |
getAssessmentsOfferedByRecordType(Type assessmentRecordType)
Gets an
AssessmentOfferedList corresponding to the
given assessment offered record Type. |
AssessmentOfferedList |
getAssessmentsOfferedForAssessment(Id assessmentId)
Gets an
AssessmentOfferedList by the given assessment. |
Bank |
getBank()
Gets the
Bank associated with this session. |
Id |
getBankId()
Gets the
Bank Id associated with this
session. |
void |
useComparativeAssessmentOfferedView()
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 |
usePlenaryAssessmentOfferedView()
A complete view of the
AssessmentOffered 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 canLookupAssessmentsOffered()
AssessmentOffered
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 useComparativeAssessmentOfferedView()
mandatory
- This method is must be implemented. void usePlenaryAssessmentOfferedView()
AssessmentOffered
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. AssessmentOffered getAssessmentOffered(Id assessmentOfferedId) throws NotFoundException, OperationFailedException, PermissionDeniedException
AssessmentOffered
specified by its Id.
In plenary mode, the exact Id
is found or a
NOT_FOUND
results. Otherwise, the returned
AssessmentOffered
may have a different Id
than
requested, such as the case where a duplicate Id
was
assigned to an AssessmentOffered
and retained for
compatibility.assessmentOfferedId
- Id
of the
AssessmentOffered
NotFoundException
- assessmentOfferedId
not foundNullArgumentException
- assessmentOfferedId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method is must be implemented. AssessmentOfferedList getAssessmentsOfferedByIds(IdList assessmentOfferedIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
AssessmentOfferedList
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 AssessmentOffered
objects may be omitted from the list and may present the elements in
any order including returning a unique set.assessmentOfferedIds
- the list of Ids
to
retrieve AssessmentOffered
listNotFoundException
- an Id was
not foundNullArgumentException
- assessmentOfferedIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- assessment failuremandatory
- This method must be implemented. AssessmentOfferedList getAssessmentsOfferedByGenusType(Type assessmentOfferedGenusType) throws OperationFailedException, PermissionDeniedException
AssessmentOfferedList
corresponding to the
given assessment offered genus Type
which does not
include assessments of types derived from the specified Type.
In plenary mode, the returned list contains all known
assessments offered or an error results. Otherwise, the returned list
may contain only those assessments offered that are accessible through
this session.assessmentOfferedGenusType
- an assessment offered genus type AssessmentOffered
listNullArgumentException
-
assessmentOfferedGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. AssessmentOfferedList getAssessmentsOfferedByParentGenusType(Type assessmentOfferedGenusType) throws OperationFailedException, PermissionDeniedException
AssessmentOfferedList
corresponding to the
given assessment offered 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 offered that are accessible through
this session.assessmentOfferedGenusType
- an assessment offered genus type AssessmentOffered
listNullArgumentException
-
assessmentOfferedGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. AssessmentOfferedList getAssessmentsOfferedByRecordType(Type assessmentRecordType) throws OperationFailedException, PermissionDeniedException
AssessmentOfferedList
corresponding to the
given assessment offered record Type.
The set of
assessments implementing the given record type is returned. In plenary
mode, the returned list contains all known assessments offered or an
error results. Otherwise, the returned list may contain only those
assessments offered that are accessible through this session.assessmentRecordType
- an assessment offered record type AssessmentOffered
listNullArgumentException
-
assessmentOfferedRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. AssessmentOfferedList getAssessmentsOfferedByDate(DateTime start, DateTime end) throws OperationFailedException, PermissionDeniedException
AssessmentOfferedList
that have designated
start times where the start times fall in the given range inclusive.
In plenary mode, the returned list contains all known assessments
offered or an error results. Otherwise, the returned list may contain
only those assessments offered that are accessible through this
session.start
- start of time rangeend
- end of time range AssessmentOffered
listInvalidArgumentException
- end
is less
than start
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. AssessmentOfferedList getAssessmentsOfferedForAssessment(Id assessmentId) throws OperationFailedException, PermissionDeniedException
AssessmentOfferedList
by the given assessment.
In plenary mode, the returned list contains all known assessments
offered or an error results. Otherwise, the returned list may contain
only those assessments offered that are accessible through this
session.assessmentId
- Id
of an Assessment
AssessmentOffered
listNullArgumentException
- assessmentId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. AssessmentOfferedList getAssessmentsOffered() throws OperationFailedException, PermissionDeniedException
AssessmentOffered
elements. In plenary mode,
the returned list contains all known assessments offered or an error
results. Otherwise, the returned list may contain only those
assessments offered that are accessible through this session. AssessmentOffered
elementsOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented.