public interface CredentialEntryQuerySession extends OsidSession
This session provides methods for searching among
CredentialEntries.
The search query is constructed using the
CredentialEntryQuery.
This session defines views that offer differing behaviors for searching.
CredentialEntries may have a query record indicated by their
respective record types. The query record is accessed via the
CredentialEntryQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchCredentialEntries()
Tests if this user can perform
CredentialEntry
searches. |
CourseCatalog |
getCourseCatalog()
Gets the
CourseCatalog associated with this session. |
Id |
getCourseCatalogId()
Gets the
CourseCatalog Id associated
with this session. |
CredentialEntryList |
getCredentialEntriesByQuery(CredentialEntryQuery credentialEntryQuery)
Gets a list of
CredentialEntries matching the given
credential entry query. |
CredentialEntryQuery |
getCredentialEntryQuery()
Gets a credential entry query.
|
void |
useFederatedCourseCatalogView()
Federates the view for methods in this session.
|
void |
useIsolatedCourseCatalogView()
Isolates the view for methods in this session.
|
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 canSearchCredentialEntries()
CredentialEntry
searches. 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 search operations to unauthorized users. false
if search methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useFederatedCourseCatalogView()
mandatory
- This method is must be implemented. void useIsolatedCourseCatalogView()
mandatory
- This method is must be implemented. CredentialEntryQuery getCredentialEntryQuery()
mandatory
- This method must be implemented. CredentialEntryList getCredentialEntriesByQuery(CredentialEntryQuery credentialEntryQuery) throws OperationFailedException, PermissionDeniedException
CredentialEntries
matching the given
credential entry query.credentialEntryQuery
- the credential entry query CredentialEntryList
NullArgumentException
- credentialEntryQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- credentialEntryQuery
is not of this servicemandatory
- This method must be implemented.