public interface CredentialEntryLookupSession extends OsidSession
This session defines methods for retrieving entriesand entry components.
This lookup session defines several views:
CredentialEntries
with the
CredentialEntry AdminSession.
The methods useFederatedCourseCatalogView()
and
useIsolatedCourseCatalogView()
behave as a radio group and one
should be selected before invoking any lookup methods.
Credential entries may have an additional records indicated by their
respective record types. The record may not be accessed through a cast of
the CredentialEntry.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupCredentialEntries()
Tests if this user can perform
CredentialEntry lookups. |
CourseCatalog |
getCourseCatalog()
Gets the
CourseCatalog associated with this session. |
Id |
getCourseCatalogId()
Gets the
CourseCatalog Id associated
with this session. |
CredentialEntryList |
getCredentialEntries()
Gets all
CredentialEntries. |
CredentialEntryList |
getCredentialEntriesByGenusType(Type credentialEntryGenusType)
Gets a
CredentialEntryList corresponding to the given
credential entry genus Type which does not include
credential entries of types derived from the specified Type. |
CredentialEntryList |
getCredentialEntriesByIds(IdList credentialEntryId)
Gets a
CredentialEntryList corresponding to the given
IdList. |
CredentialEntryList |
getCredentialEntriesByParentGenusType(Type credentialEntryGenusType)
Gets a
CredentialEntryList corresponding to the given
credential entry genus Type and include any additional
credential entries with genus types derived from the specified
Type. |
CredentialEntryList |
getCredentialEntriesByRecordType(Type credentialEntryRecordType)
Gets a
CredentialEntryList containing the given
credential entry record Type. |
CredentialEntryList |
getCredentialEntriesForCredential(Id credentialId)
Gets a
CredentialEntryList for the given credential. |
CredentialEntryList |
getCredentialEntriesForCredentialOnDate(Id credentialId,
DateTime from,
DateTime to)
Gets a
CredentialEntryList for the given credential
effective during the entire given date range inclusive but not
confined to the date range. |
CredentialEntryList |
getCredentialEntriesForStudent(Id resourceId)
Gets a
CredentialEntryList for the given student
. |
CredentialEntryList |
getCredentialEntriesForStudentAndCredential(Id resourceId,
Id credentialId)
Gets a
CredentialEntryList for the given student and
credential . |
CredentialEntryList |
getCredentialEntriesForStudentAndCredentialOnDate(Id resourceId,
Id credentialId,
DateTime from,
DateTime to)
Gets a
CredentialEntryList for the given student and
credential effective during the entire given date range inclusive but
not confined to the date range. |
CredentialEntryList |
getCredentialEntriesForStudentOnDate(Id resourceId,
DateTime from,
DateTime to)
Gets a
CredentialEntryList for the given student
effective during the entire given date range inclusive but not
confined to the date range. |
CredentialEntryList |
getCredentialEntriesOnDate(DateTime from,
DateTime to)
Gets a
CredentialEntryList effective during the entire
given date range inclusive but not confined to the date range. |
CredentialEntry |
getCredentialEntry(Id credentialEntryId)
Gets the
CredentialEntry specified by its Id. |
void |
useAnyEffectiveCredentialEntryView()
All credential entries of any effective dates are returned by methods
in this session.
|
void |
useComparativeCredentialEntryView()
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 |
useEffectiveCredentialEntryView()
Only credential entries whose effective dates are current are returned
by methods in this session.
|
void |
useFederatedCourseCatalogView()
Federates the view for methods in this session.
|
void |
useIsolatedCourseCatalogView()
Isolates the view for methods in this session.
|
void |
usePlenaryCredentialEntryView()
A complete view of the
CredentialEntry returns is
desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getCourseCatalogId()
CourseCatalog
Id
associated
with this session. CourseCatalog Id
associated with this
sessionmandatory
- This method must be implemented. CourseCatalog getCourseCatalog() throws OperationFailedException, PermissionDeniedException
CourseCatalog
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupCredentialEntries()
CredentialEntry
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 useComparativeCredentialEntryView()
mandatory
- This method is must be implemented. void usePlenaryCredentialEntryView()
CredentialEntry
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 useFederatedCourseCatalogView()
mandatory
- This method is must be implemented. void useIsolatedCourseCatalogView()
mandatory
- This method is must be implemented. void useEffectiveCredentialEntryView()
mandatory
- This method is must be implemented. void useAnyEffectiveCredentialEntryView()
mandatory
- This method is must be implemented. CredentialEntry getCredentialEntry(Id credentialEntryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
CredentialEntry
specified by its Id.
In plenary mode, the exact Id
is found or a
NOT_FOUND
results.
Otherwise, the returned CredentialEntry
may have a
different Id
than requested, such as the case where a
duplicate Id
was assigned to a CredentialEntry
and retained for compatibility.
In effective mode, credential entries are returned that are currently
effective. In any effective mode, effective credential entries and
those currently expired are returned.credentialEntryId
- the Id
of the
CredentialEntry
to retrieve CredentialEntry
NotFoundException
- no CredentialEntry
found with the given Id
NullArgumentException
- credentialEntryId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CredentialEntryList getCredentialEntriesByIds(IdList credentialEntryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
CredentialEntryList
corresponding to the given
IdList.
In plenary mode, the returned list contains all of the
credential entries 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 CredentialEntries
may be
omitted from the list and may present the elements in any order
including returning a unique set.
In effective mode, credential entries are returned that are currently
effective. In any effective mode, effective credential entries and
those currently expired are returned.credentialEntryId
- the list of Ids
to retrieve CredentialEntryList
NotFoundException
- an Id was
not foundNullArgumentException
- credentialEntryId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CredentialEntryList getCredentialEntriesByGenusType(Type credentialEntryGenusType) throws OperationFailedException, PermissionDeniedException
CredentialEntryList
corresponding to the given
credential entry genus Type
which does not include
credential entries of types derived from the specified Type.
In plenary mode, the returned list contains all known
credential entries or an error results. Otherwise, the returned list
may contain only those credential entries that are accessible through
this session.
In effective mode, credential entries are returned that are currently
effective. In any effective mode, effective credential entries and
those currently expired are returned.credentialEntryGenusType
- a credential entry genus type CredentialEntryList
NullArgumentException
- credentialEntryGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CredentialEntryList getCredentialEntriesByParentGenusType(Type credentialEntryGenusType) throws OperationFailedException, PermissionDeniedException
CredentialEntryList
corresponding to the given
credential entry genus Type
and include any additional
credential entries with genus types derived from the specified
Type.
In plenary mode, the returned list contains all known
credential entries or an error results. Otherwise, the returned list
may contain only those credential entries that are accessible through
this session.
In effective mode, credential entries are returned that are currently
effective. In any effective mode, effective credential entries and
those currently expired are returned.credentialEntryGenusType
- a credential entry genus type CredentialEntryList
NullArgumentException
- credentialEntryGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CredentialEntryList getCredentialEntriesByRecordType(Type credentialEntryRecordType) throws OperationFailedException, PermissionDeniedException
CredentialEntryList
containing the given
credential entry record Type.
In plenary mode, the returned list contains all known credential
entries or an error results. Otherwise, the returned list may contain
only those credential entries that are accessible through this
session.
In effective mode, credential entries are returned that are currently
effective. In any effective mode, effective credential entries and
those currently expired are returned.credentialEntryRecordType
- a credential entry record type CredentialEntryList
listNullArgumentException
-
credentialEntryRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CredentialEntryList getCredentialEntriesOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
CredentialEntryList
effective during the entire
given date range inclusive but not confined to the date range.
In plenary mode, the returned list contains all known credential
entries or an error results. Otherwise, the returned list may contain
only those credential entries that are accessible through this
session.
In effective mode, credential entries are returned that are currently
effective. In any effective mode, effective credential entries and
those currently expired are returned.from
- starting dateto
- ending date CredentialEntryList
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- from
or
to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CredentialEntryList getCredentialEntriesForStudent(Id resourceId) throws OperationFailedException, PermissionDeniedException
CredentialEntryList
for the given student
.
In plenary mode, the returned list contains all known credential
entries or an error results. Otherwise, the returned list may contain
only those credential entries that are accessible through this
session.
In effective mode, credential entries are returned that are currently
effective. In any effective mode, effective credential entries and
those currently expired are returned.resourceId
- a resource Id
CredentialEntryList
listNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CredentialEntryList getCredentialEntriesForStudentOnDate(Id resourceId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
CredentialEntryList
for the given student
effective during the entire given date range inclusive but not
confined to the date range.
In plenary mode, the returned list contains all known credential
entries or an error results. Otherwise, the returned list may contain
only those credential entries that are accessible through this
session.
In effective mode, credential entries are returned that are currently
effective. In any effective mode, effective credential entries and
those currently expired are returned.resourceId
- a resource Id
from
- starting dateto
- ending date CredentialEntryList
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- resourceId, from
, or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CredentialEntryList getCredentialEntriesForCredential(Id credentialId) throws OperationFailedException, PermissionDeniedException
CredentialEntryList
for the given credential.
In plenary mode, the returned list contains all known credential
entries or an error results. Otherwise, the returned list may contain
only those credential entries that are accessible through this
session.
In effective mode, credential entries are returned that are currently
effective. In any effective mode, effective credential entries and
those currently expired are returned.credentialId
- a credential Id
CredentialEntryList
listNullArgumentException
- credentialId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CredentialEntryList getCredentialEntriesForCredentialOnDate(Id credentialId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
CredentialEntryList
for the given credential
effective during the entire given date range inclusive but not
confined to the date range.
In plenary mode, the returned list contains all known credential
entries or an error results. Otherwise, the returned list may contain
only those credential entries that are accessible through this
session.
In effective mode, credential entries are returned that are currently
effective. In any effective mode, effective credential entries and
those currently expired are returned.credentialId
- a credential Id
from
- starting dateto
- ending date CredentialEntryList
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- credentialId, from
, or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CredentialEntryList getCredentialEntriesForStudentAndCredential(Id resourceId, Id credentialId) throws OperationFailedException, PermissionDeniedException
CredentialEntryList
for the given student and
credential .
In plenary mode, the returned list contains all known credential
entries or an error results. Otherwise, the returned list may contain
only those credential entries that are accessible through this
session.
In effective mode, credential entries are returned that are currently
effective. In any effective mode, effective credential entries and
those currently expired are returned.resourceId
- a resource Id
credentialId
- a credential Id
CredentialEntryList
listNullArgumentException
- resourceId
or
credentialId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CredentialEntryList getCredentialEntriesForStudentAndCredentialOnDate(Id resourceId, Id credentialId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
CredentialEntryList
for the given student and
credential effective during the entire given date range inclusive but
not confined to the date range.
In plenary mode, the returned list contains all known credential
entries or an error results. Otherwise, the returned list may contain
only those credential entries that are accessible through this
session.
In effective mode, credential entries are returned that are currently
effective. In any effective mode, effective credential entries and
those currently expired are returned.resourceId
- a resource Id
credentialId
- a credential Id
from
- starting dateto
- ending date CredentialEntryList
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- resourceId,
credentialId, from
, or to
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CredentialEntryList getCredentialEntries() throws OperationFailedException, PermissionDeniedException
CredentialEntries.
In plenary mode, the returned list contains all known credential
entries or an error results. Otherwise, the returned list may contain
only those credential entries that are accessible through this
session.
In effective mode, credential entries are returned that are currently
effective. In any effective mode, effective credential entries and
those currently expired are returned. CredentialEntries
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.