Interface RegistrationRequestItemSearchSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, RegistrationRequestItemQuerySession
public interface RegistrationRequestItemSearchSession extends RegistrationRequestItemQuerySession

This session provides methods for searching among RegistrationRequestItems . The search query is constructed using the RegistrationRequestItemQuery .

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

This session defines views that offer differing behaviors for searching.

  • federated course catalog view: searches include registration request items 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 request items in this course catalog

Registration Request Items may have a query record indicated by their respective record types. The quer y record is accessed via the RegistrationRequestItemQuery .

  • Method Details

    • getRegistrationRequestItemSearch

      RegistrationRequestItemSearch getRegistrationRequestItemSearch()
      Gets a registration request item search.
      Returns:
      the registration request item search
      Compliance:
      mandatory - This method must be implemented.

    • getRegistrationRequestItemSearchOrder

      RegistrationRequestItemSearchOrder getRegistrationRequestItemSearchOrder()
      Gets a registration request item search order. The RegistrationRequestItemSearchOrder is supplied to a RegistrationRequestItemSearch to specify the ordering of results.
      Returns:
      the registration request item search order
      Compliance:
      mandatory - This method must be implemented.

    • getRegistrationRequestItemsBySearch

      RegistrationRequestItemSearchResults getRegistrationRequestItemsBySearch(RegistrationRequestItemQuery registrationRequestItemQuery, RegistrationRequestItemSearch registrationRequestItemSearch) throws OperationFailedException, PermissionDeniedException
      Gets the search results matching the given search query using the given search.
      Parameters:
      registrationRequestItemQuery - the registration request item query
      registrationRequestItemSearch - the registration request item search
      Returns:
      the returned search results
      Throws:
      NullArgumentException - registrationRequestItemQuery or registrationRequestItemSearch is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - registrationRequestItemQuery or registrationRequestItemSearch is not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getRegistrationRequestItemQueryFromInspector

      RegistrationRequestItemQuery getRegistrationRequestItemQueryFromInspector(RegistrationRequestItemQueryInspector registrationRequestItemQueryInspector)
      Gets a registration request item query from an inspector. The inspector is available from a RegistrationRequestItemSearchResults .
      Parameters:
      registrationRequestItemQueryInspector - a registration request item query inspector
      Returns:
      the registration request item query
      Throws:
      NullArgumentException - registrationRequestItemQueryInspector is null
      UnsupportedException - registrationRequestItemQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.