public interface RegistrationQuerySession extends OsidSession
This session provides methods for searching among Registration
objects. The search query is constructed using the
RegistrationQuery.
This session defines views that offer differing behaviors for searching.
Registrations may have a query record indicated by their respective
record types. The query record is accessed via the
RegistrationQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchRegistrations()
Tests if this user can perform
Registration lookups. |
CourseCatalog |
getCourseCatalog()
Gets the
CourseCatalog associated with this session. |
Id |
getCourseCatalogId()
Gets the
CourseCatalog Id associated
with this session. |
RegistrationQuery |
getRegistrationQuery()
Gets a registration query.
|
RegistrationList |
getRegistrationsByQuery(RegistrationQuery courseQuery)
Gets a list of
Registrations matching the given
registration 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 canSearchRegistrations()
Registration
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 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. RegistrationQuery getRegistrationQuery()
mandatory
- This method must be implemented. RegistrationList getRegistrationsByQuery(RegistrationQuery courseQuery) throws OperationFailedException, PermissionDeniedException
Registrations
matching the given
registration query.courseQuery
- the registration query RegistrationList
NullArgumentException
- registrationQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- registrationQuery
is not of this servicemandatory
- This method must be implemented.