Interface CommitmentEnablerSearchSession

All Superinterfaces:
AutoCloseable, Closeable, CommitmentEnablerQuerySession, OsidSession, OsidSession
public interface CommitmentEnablerSearchSession extends CommitmentEnablerQuerySession

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

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

This session defines views that offer differing behaviors for searching.

  • federated calendar view: searches include commitment enablers in calendars of which this calendar is an ancestor in the calendar hierarchy
  • isolated calendar view: searches are restricted to commitment enablers in this calendar
CommitmentEnablers may have a query record indicated by their respective record types. The query record is accessed via the CommitmentEnablerQuery.

Like all OsidSessions, CommitmentEnablerSearchSessions are dedicated to single processing threads and a single authenticated user.

  • Method Details

    • getCommitmentEnablerSearch

      CommitmentEnablerSearch getCommitmentEnablerSearch()
      Gets a commitment enabler search.
      Returns:
      the commitment enabler search
      Compliance:
      mandatory - This method must be implemented.

    • getCommitmentEnablerSearchOrder

      CommitmentEnablerSearchOrder getCommitmentEnablerSearchOrder()
      Gets a commitment enabler search order. The CommitmentEnablerSearchOrder is supplied to a CommitmentEnablerSearch to specify the ordering of results.
      Returns:
      the commitment enabler search order
      Compliance:
      mandatory - This method must be implemented.

    • getCommitmentEnablersBySearch

      CommitmentEnablerSearchResults getCommitmentEnablersBySearch(CommitmentEnablerQuery commitmentEnablerQuery, CommitmentEnablerSearch commitmentEnablerSearch) throws OperationFailedException, PermissionDeniedException
      Gets the search results matching the given search query using the given search.
      Parameters:
      commitmentEnablerQuery - the commitment enabler query
      commitmentEnablerSearch - the commitment enabler search
      Returns:
      the returned search results
      Throws:
      NullArgumentException - commitmentEnablerQuery or commitmentEnablerSearch is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - commitmentEnablerQuery or commitmentEnablerSearch is not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getCommitmentEnablerQueryFromInspector

      CommitmentEnablerQuery getCommitmentEnablerQueryFromInspector(CommitmentEnablerQueryInspector commitmentEnablerQueryInspector)
      Gets a commitment enabler query from an inspector. The inspector is available from a CommitmentEnablerSearchResults.
      Parameters:
      commitmentEnablerQueryInspector - a commitment enabler query inspector
      Returns:
      the commitment enabler query
      Throws:
      NullArgumentException - commitmentEnablerQueryInspector is null
      UnsupportedException - commitmentEnablerQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.