org.osid.course.registration

Interface ActivityRegistrationSearchSession

All Superinterfaces:

ActivityRegistrationQuerySession, java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface ActivityRegistrationSearchSession
extends ActivityRegistrationQuerySession

This session provides methods for searching among ActivityRegistration objects. The search query is constructed using the ActivityRegistrationQuery.

getActivityRegistrationsByQuery() is the basic search method and returns a list of ActivityRegistrations. A more advanced search may be performed with getActivityRegistrationsBySearch(). It accepts an ActivityRegistrationSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getActivityRegistrationsBySearch() returns an ActivityRegistrationSearchResults that can be used to access the resulting ActivityRegistrationList or be used to perform a search within the result set through ActivityRegistrationSearch.

This session defines views that offer differing behaviors for searching.

• federated course catalog view: searches include activity registrations in course catalogs of which this course catalog is an ancestor in the course catalog hierarchy
• isolated course catalog view: searches are restricted to activity registrations in this course catalog

Activity Registrations may have a query record indicated by their respective record types. The query record is accessed via the ActivityRegistrationQuery.

Method Summary

Methods

Modifier and Type	Method and Description
ActivityRegistrationQuery	getActivityRegistrationQueryFromInspector(ItemQueryInspector activityRegistrationQueryInspector) Gets an activity registration query from an inspector.
ActivityRegistrationSearchResults	getActivityRegistrationsBySearch(ActivityRegistrationQuery activityRegistrationQuery, ActivityRegistrationSearch activityRegistrationSearch) Gets the search results matching the given search query using the given search.
ActivityRegistrationSearch	getActivityRegistrationSearch() Gets an activity registration search.
ActivityRegistrationSearchOrder	getActivityRegistrationSearchOrder() Gets an activity search order.

Methods inherited from interface org.osid.course.registration.ActivityRegistrationQuerySession

canSearchActivityRegistrations, getActivityRegistrationQuery, getActivityRegistrationsByQuery, getCourseCatalog, getCourseCatalogId, useFederatedCourseCatalogView, useIsolatedCourseCatalogView

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getActivityRegistrationSearch

ActivityRegistrationSearch getActivityRegistrationSearch()

Gets an activity registration search.

Returns:

the activity registration search

Compliance:

mandatory - This method must be implemented.

getActivityRegistrationSearchOrder

ActivityRegistrationSearchOrder getActivityRegistrationSearchOrder()

Gets an activity search order. The ActivityRegistrationSearchOrder is supplied to an ActivityRegistrationSearch to specify the ordering of results.

Returns:

the activity registration search order

Compliance:

mandatory - This method must be implemented.

getActivityRegistrationsBySearch

ActivityRegistrationSearchResults getActivityRegistrationsBySearch(ActivityRegistrationQuery activityRegistrationQuery,
                                                                 ActivityRegistrationSearch activityRegistrationSearch)
                                                                   throws OperationFailedException,
                                                                          PermissionDeniedException

Gets the search results matching the given search query using the given search.

Parameters:

activityRegistrationQuery - the activity registration query

activityRegistrationSearch - the activity registration search

Returns:

the returned search results

Throws:

NullArgumentException - activityRegistrationQuery or activityRegistrationSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - activityRegistrationQuery or activityRegistrationSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getActivityRegistrationQueryFromInspector

ActivityRegistrationQuery getActivityRegistrationQueryFromInspector(ItemQueryInspector activityRegistrationQueryInspector)

Gets an activity registration query from an inspector. The inspector is available from an ActivityRegistrationSearchResults.

Parameters:

activityRegistrationQueryInspector - an activity registration query inspector

Returns:

the activity registration query

Throws:

NullArgumentException - activityRegistrationQueryInspector is null

UnsupportedException - activityRegistrationQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.