public interface AssessmentTakenLookupSession extends OsidSession
This session defines methods for retrieving assessments taken.
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.
Assessments taken may have a record indicated by their respective
record types. The record is accessed via the AssessmentTaken.
The returns may not be cast directly from the returns in the
lookup methods.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupAssessmentsTaken()
Tests if this user can perform
AssessmentTaken lookups. |
AssessmentTakenList |
getAssessmentsTaken()
Gets all
AssessmentTaken elements. |
AssessmentTakenList |
getAssessmentsTakenByDate(DateTime from,
DateTime to)
Gets an
AssessmentTakenList started in the given date
range inclusive. |
AssessmentTakenList |
getAssessmentsTakenByDateForAssessment(Id assessmentId,
DateTime from,
DateTime to)
Gets an
AssessmentTakenList started in the given date
range inclusive for the given assessment. |
AssessmentTakenList |
getAssessmentsTakenByDateForAssessmentOffered(Id assessmentOfferedId,
DateTime from,
DateTime to)
Gets an
AssessmentTakenList started in the given date
range inclusive for the given assessment offered. |
AssessmentTakenList |
getAssessmentsTakenByDateForTaker(Id resourceId,
DateTime from,
DateTime to)
Gets an
AssessmentTakenList started in the given date
range inclusive for the given resource. |
AssessmentTakenList |
getAssessmentsTakenByDateForTakerAndAssessment(Id resourceId,
Id assessmentId,
DateTime from,
DateTime to)
Gets an
AssessmentTakenList started in the given date
range inclusive for the given resource and assessment. |
AssessmentTakenList |
getAssessmentsTakenByDateForTakerAndAssessmentOffered(Id resourceId,
Id assessmentOfferedId,
DateTime from,
DateTime to)
Gets an
AssessmentTakenList started in the given date
range inclusive for the given resource and assessment offered. |
AssessmentTakenList |
getAssessmentsTakenByGenusType(Type assessmentTakenGenusType)
Gets an
AssessmentTakenList corresponding to the given
assessment taken genus Type which does not include
assessments of types derived from the specified Type. |
AssessmentTakenList |
getAssessmentsTakenByIds(IdList assessmentTakenIds)
Gets an
AssessmentTakenList corresponding to the given
IdList. |
AssessmentTakenList |
getAssessmentsTakenByParentGenusType(Type assessmentTakenGenusType)
Gets an
AssessmentTakenList corresponding to the given
assessment taken genus Type and include any additional
assessments with genus types derived from the specified Type. |
AssessmentTakenList |
getAssessmentsTakenByRecordType(Type assessmentTakenRecordType)
Gets an
AssessmentTakenList corresponding to the given
assessment taken record Type. |
AssessmentTakenList |
getAssessmentsTakenForAssessment(Id assessmentId)
Gets an
AssessmentTakenList for the given assessment. |
AssessmentTakenList |
getAssessmentsTakenForAssessmentOffered(Id assessmentOfferedId)
Gets an
AssessmentTakenList by the given assessment
offered. |
AssessmentTakenList |
getAssessmentsTakenForTaker(Id resourceId)
Gets an
AssessmentTakenList for the given resource. |
AssessmentTakenList |
getAssessmentsTakenForTakerAndAssessment(Id resourceId,
Id assessmentId)
Gets an
AssessmentTakenList for the given resource and
assessment. |
AssessmentTakenList |
getAssessmentsTakenForTakerAndAssessmentOffered(Id resourceId,
Id assessmentOfferedId)
Gets an
AssessmentTakenList for the given resource and
assessment offered. |
AssessmentTaken |
getAssessmentTaken(Id assessmentTakenId)
Gets the
AssessmentTaken specified by its Id. |
Bank |
getBank()
Gets the
Bank associated with this session. |
Id |
getBankId()
Gets the
Bank Id associated with this
session. |
void |
useComparativeAssessmentTakenView()
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 |
usePlenaryAssessmentTakenView()
A complete view of the
AssessmentTaken 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 canLookupAssessmentsTaken()
AssessmentTaken
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 useComparativeAssessmentTakenView()
mandatory
- This method is must be implemented. void usePlenaryAssessmentTakenView()
AssessmentTaken
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. AssessmentTaken getAssessmentTaken(Id assessmentTakenId) throws NotFoundException, OperationFailedException, PermissionDeniedException
AssessmentTaken
specified by its Id.
In plenary mode, the exact Id
is found or a
NOT_FOUND
results. Otherwise, the returned
AssessmentTaken
may have a different Id
than
requested, such as the case where a duplicate Id
was
assigned to an AssessmentTaken
and retained for
compatibility.assessmentTakenId
- Id
of the
AssessmentTaken
NotFoundException
- assessmentTakenId
not foundNullArgumentException
- assessmentTakenId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method is must be implemented. AssessmentTakenList getAssessmentsTakenByIds(IdList assessmentTakenIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
AssessmentTakenList
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 AssessmentTaken
objects may be
omitted from the list and may present the elements in any order
including returning a unique set.assessmentTakenIds
- the list of Ids
to retrieve AssessmentTaken list
NotFoundException
- an Id was
not foundNullArgumentException
- assessmentTakenIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- assessment failuremandatory
- This method must be implemented. AssessmentTakenList getAssessmentsTakenByGenusType(Type assessmentTakenGenusType) throws OperationFailedException, PermissionDeniedException
AssessmentTakenList
corresponding to the given
assessment taken genus Type
which does not include
assessments of types derived from the specified Type.
In plenary mode, the returned list contains all known assessments
taken or an error results. Otherwise, the returned list may contain
only those assessments taken that are accessible through this session.assessmentTakenGenusType
- an assessment taken genus type AssessmentTaken list
NullArgumentException
- assessmentTakenGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. AssessmentTakenList getAssessmentsTakenByParentGenusType(Type assessmentTakenGenusType) throws OperationFailedException, PermissionDeniedException
AssessmentTakenList
corresponding to the given
assessment taken 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 taken that are accessible through this
session.assessmentTakenGenusType
- an assessment taken genus type AssessmentTaken list
NullArgumentException
- assessmentTakenGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. AssessmentTakenList getAssessmentsTakenByRecordType(Type assessmentTakenRecordType) throws OperationFailedException, PermissionDeniedException
AssessmentTakenList
corresponding to the given
assessment taken record Type.
The set of assessments
implementing the given record type is returned. In plenary mode, the
returned list contains all known assessments taken or an error
results. Otherwise, the returned list may contain only those
assessments taken that are accessible through this session. In both
cases, the order of the set is not specified.assessmentTakenRecordType
- an assessment taken record type AssessmentTaken
listNullArgumentException
-
assessmentTakenRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. AssessmentTakenList getAssessmentsTakenByDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
AssessmentTakenList
started in the given date
range inclusive. In plenary mode, the returned list contains all known
assessments taken or an error results. Otherwise, the returned list
may contain only those assessments taken that are accessible through
this session. In both cases, the order of the set is not specified.from
- start dateto
- end date AssessmentTaken
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- from
or
to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. AssessmentTakenList getAssessmentsTakenForTaker(Id resourceId) throws OperationFailedException, PermissionDeniedException
AssessmentTakenList
for the given resource. In
plenary mode, the returned list contains all known assessments taken
or an error results. Otherwise, the returned list may contain only
those assessments taken that are accessible through this session.resourceId
- Id
of a Resource
AssessmentTaken
listNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. AssessmentTakenList getAssessmentsTakenByDateForTaker(Id resourceId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
AssessmentTakenList
started in the given date
range inclusive for the given resource. In plenary mode, the returned
list contains all known assessments taken or an error results.
Otherwise, the returned list may contain only those assessments taken
that are accessible through this session.resourceId
- Id
of a Resource
from
- start dateto
- end date AssessmentTaken
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- resourceId, from
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. AssessmentTakenList getAssessmentsTakenForAssessment(Id assessmentId) throws OperationFailedException, PermissionDeniedException
AssessmentTakenList
for the given assessment.
In plenary mode, the returned list contains all known assessments
taken or an error results. Otherwise, the returned list may contain
only those assessments taken that are accessible through this session.assessmentId
- Id
of an Assessment
AssessmentTaken
listNullArgumentException
- assessmentId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. AssessmentTakenList getAssessmentsTakenByDateForAssessment(Id assessmentId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
AssessmentTakenList
started in the given date
range inclusive for the given assessment. In plenary mode, the
returned list contains all known assessments taken or an error
results. Otherwise, the returned list may contain only those
assessments taken that are accessible through this session.assessmentId
- Id
of an Assessment
from
- start dateto
- end date AssessmentTaken
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- assessmentId, from
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. AssessmentTakenList getAssessmentsTakenForTakerAndAssessment(Id resourceId, Id assessmentId) throws OperationFailedException, PermissionDeniedException
AssessmentTakenList
for the given resource and
assessment. In plenary mode, the returned list contains all known
assessments taken or an error results. Otherwise, the returned list
may contain only those assessments taken that are accessible through
this session.resourceId
- Id
of a Resource
assessmentId
- Id
of an Assessment
AssessmentTaken
listNullArgumentException
- resourceId
or
assessmentId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. AssessmentTakenList getAssessmentsTakenByDateForTakerAndAssessment(Id resourceId, Id assessmentId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
AssessmentTakenList
started in the given date
range inclusive for the given resource and assessment. In plenary
mode, the returned list contains all known assessments taken or an
error results. Otherwise, the returned list may contain only those
assessments taken that are accessible through this session.resourceId
- Id
of a Resource
assessmentId
- Id
of an Assessment
from
- start dateto
- end date AssessmentTaken
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- resourceId,
assessmentId, from
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. AssessmentTakenList getAssessmentsTakenForAssessmentOffered(Id assessmentOfferedId) throws OperationFailedException, PermissionDeniedException
AssessmentTakenList
by the given assessment
offered. In plenary mode, the returned list contains all known
assessments taken or an error results. Otherwise, the returned list
may contain only those assessments taken that are accessible through
this session.assessmentOfferedId
- Id
of an
AssessmentOffered
AssessmentTaken
listNullArgumentException
- assessmentOfferedId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. AssessmentTakenList getAssessmentsTakenByDateForAssessmentOffered(Id assessmentOfferedId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
AssessmentTakenList
started in the given date
range inclusive for the given assessment offered. In plenary mode, the
returned list contains all known assessments taken or an error
results. Otherwise, the returned list may contain only those
assessments taken that are accessible through this session.assessmentOfferedId
- Id
of an
AssessmentOffered
from
- start dateto
- end date AssessmentTaken
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- assessmentOfferedId,
from,
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. AssessmentTakenList getAssessmentsTakenForTakerAndAssessmentOffered(Id resourceId, Id assessmentOfferedId) throws OperationFailedException, PermissionDeniedException
AssessmentTakenList
for the given resource and
assessment offered. In plenary mode, the returned list contains all
known assessments taken or an error results. Otherwise, the returned
list may contain only those assessments taken that are accessible
through this session.resourceId
- Id
of a Resource
assessmentOfferedId
- Id
of an
AssessmentOffered
AssessmentTaken
listNullArgumentException
- resourceId
or
assessmenOfferedtId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. AssessmentTakenList getAssessmentsTakenByDateForTakerAndAssessmentOffered(Id resourceId, Id assessmentOfferedId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
AssessmentTakenList
started in the given date
range inclusive for the given resource and assessment offered. In
plenary mode, the returned list contains all known assessments taken
or an error results. Otherwise, the returned list may contain only
those assessments taken that are accessible through this session.resourceId
- Id
of a Resource
assessmentOfferedId
- Id
of an
AssessmentOffered
from
- start dateto
- end date AssessmentTaken
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- resourceId,
assessmentOfferedId, from,
or to
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. AssessmentTakenList getAssessmentsTaken() throws OperationFailedException, PermissionDeniedException
AssessmentTaken
elements. In plenary mode, the
returned list contains all known assessments taken or an error
results. Otherwise, the returned list may contain only those
assessments taken that are accessible through this session. AssessmentTaken
elementsOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented.