Interface CanonicalUnitEnablerSearchSession

All Superinterfaces:
AutoCloseable, CanonicalUnitEnablerQuerySession, Closeable, OsidSession, OsidSession
public interface CanonicalUnitEnablerSearchSession extends CanonicalUnitEnablerQuerySession

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

getCanonicalUnitEnablersByQuery() is the basic search method and returns a list of CanonicalUnitEnablers. A more advanced search may be performed with getCanonicalUnitEnablersBySearch(). It accepts a CanonicalUnitEnablerSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as offering. getCanonicalUnitEnablersBySearch() returns a CanonicalUnitEnablerSearchResults that can be used to access the resulting CanonicalUnitEnablerList or be used to perform a search within the result set through CanonicalUnitEnablerSearch.

This session defines views that offer differing behaviors for searching.

  • federated catalogue view: searches include canonical unit enablers in catalogues of which this catalogue is an ancestor in the catalogue hierarchy
  • isolated catalogue view: searches are restricted to canonical unit enablers in this catalogue
CanonicalUnitEnablers may have a query record indicated by their respective record types. The query record is accessed via the CanonicalUnitEnablerQuery.

  • Method Details

    • getCanonicalUnitEnablerSearch

      CanonicalUnitEnablerSearch getCanonicalUnitEnablerSearch()
      Gets a canonical unit enabler search.
      Returns:
      the canonical unit enabler search
      Compliance:
      mandatory - This method must be implemented.

    • getCanonicalUnitEnablerSearchOrder

      CanonicalUnitEnablerSearchOrder getCanonicalUnitEnablerSearchOrder()
      Gets a canonical unit enabler search order. The CanonicalUnitEnablerSearchOrder is supplied to a CanonicalUnitEnablerSearch to specify the ordering of results.
      Returns:
      the canonical unit enabler search order
      Compliance:
      mandatory - This method must be implemented.

    • getCanonicalUnitEnablersBySearch

      CanonicalUnitEnablerSearchResults getCanonicalUnitEnablersBySearch(CanonicalUnitEnablerQuery canonicalUnitEnablerQuery, CanonicalUnitEnablerSearch canonicalUnitEnablerSearch) throws OperationFailedException, PermissionDeniedException
      Gets the search results matching the given search query using the given search.
      Parameters:
      canonicalUnitEnablerQuery - the canonical unit enabler query
      canonicalUnitEnablerSearch - the canonical unit enabler search
      Returns:
      the returned search results
      Throws:
      NullArgumentException - canonicalUnitEnablerQuery or canonicalUnitEnablerSearch is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - canonicalUnitEnablerQuery or canonicalUnitEnablerSearch is not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getCanonicalUnitEnablerQueryFromInspector

      CanonicalUnitEnablerQuery getCanonicalUnitEnablerQueryFromInspector(CanonicalUnitEnablerQueryInspector canonicalUnitEnablerQueryInspector)
      Gets a canonical unit enabler query from an inspector. The inspector is available from a CanonicalUnitEnablerSearchResults.
      Parameters:
      canonicalUnitEnablerQueryInspector - a canonical unit enabler query inspector
      Returns:
      the canonical unit enabler query
      Throws:
      NullArgumentException - canonicalUnitEnablerQueryInspector is null
      UnsupportedException - canonicalUnitEnablerQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.