Interface RegistrationTargetSearchSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, RegistrationTargetQuerySession
public interface RegistrationTargetSearchSession extends RegistrationTargetQuerySession

This session provides methods for searching among RegistrationTargets . The search query is constructed using the RegistrationTargetQuery .

getRegistrationTargetsByQuery() is the basic search method and returns a list of RegistrationTargets . A more advanced search may be performed with getRegistrationTargetsBySearch() . It accepts a RegistrationTargetSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getRegistrationTargetsBySearch() returns a RegistrationTargetSearchResults that can be used to access the resulting RegistrationTargetList or be used to perform a search within the result set through RegistrationTargetSearch .

This session defines views that offer differing behaviors for searching.

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

Registration Targets may have a query record indicated by their respective record types. The query record is access ed via the RegistrationTargetQuery .

  • Method Details

    • getRegistrationTargetSearch

      RegistrationTargetSearch getRegistrationTargetSearch()
      Gets a registration target search.
      Returns:
      the registration target search
      Compliance:
      mandatory - This method must be implemented.

    • getRegistrationTargetSearchOrder

      RegistrationTargetSearchOrder getRegistrationTargetSearchOrder()
      Gets a registration target search order. The RegistrationTargetSearchOrder is supplied to a RegistrationTargetSearch to specify the ordering of results.
      Returns:
      the registration target search order
      Compliance:
      mandatory - This method must be implemented.

    • getRegistrationTargetsBySearch

      RegistrationTargetSearchResults getRegistrationTargetsBySearch(RegistrationTargetQuery registrationTargetQuery, RegistrationTargetSearch registrationTargetSearch) throws OperationFailedException, PermissionDeniedException
      Gets the search results matching the given search query using the given search.
      Parameters:
      registrationTargetQuery - the registration target query
      registrationTargetSearch - the registration target search
      Returns:
      the returned search results
      Throws:
      NullArgumentException - registrationTargetQuery or registrationTargetSearch is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - registrationTargetQuery or registrationTargetSearch is not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getRegistrationTargetQueryFromInspector

      RegistrationTargetQuery getRegistrationTargetQueryFromInspector(RegistrationTargetQueryInspector registrationTargetQueryInspector)
      Gets a registration target query from an inspector. The inspector is available from a RegistrationTargetSearchResults .
      Parameters:
      registrationTargetQueryInspector - a registration target query inspector
      Returns:
      the registration target query
      Throws:
      NullArgumentException - registrationTargetQueryInspector is null
      UnsupportedException - registrationTargetQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.