Interface IssueConstrainerEnablerSearchSession

All Superinterfaces:
AutoCloseable, Closeable, IssueConstrainerEnablerQuerySession, OsidSession, OsidSession
public interface IssueConstrainerEnablerSearchSession extends IssueConstrainerEnablerQuerySession

This session provides methods for searching among IssueConstrainerEnablers . The search query is constructed using the IssueConstrainerEnablerQuery .

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

This session defines views that offer differing behaviors for searching.

  • federated oubliette view: searches include issue constrainer enablers in oubliettes of which this oubliette is an ancestor in the oubliette hierarchy
  • isolated oubliette view: searches are restricted to issue constrainer enablers in this oubliette

Issue constrainer enablers may have a query record indicated by their respective record types. The query record is accessed via the IssueConstrainerEnablerQuery .

  • Method Details

    • getIssueConstrainerEnablerSearch

      IssueConstrainerEnablerSearch getIssueConstrainerEnablerSearch()
      Gets an issue constrainer enabler search.
      Returns:
      the issue constrainer enabler search
      Compliance:
      mandatory - This method must be implemented.

    • getIssueConstrainerEnablerSearchOrder

      IssueConstrainerEnablerSearchOrder getIssueConstrainerEnablerSearchOrder()
      Gets an issue constrainer enabler search order. The IssueConstrainerEnablerSearchOrder is supplied to an IssueConstrainerEnablerSearch to specify the ordering of results.
      Returns:
      the issue constrainer enabler search order
      Compliance:
      mandatory - This method must be implemented.

    • getIssueConstrainerEnablersBySearch

      IssueConstrainerEnablerSearchResults getIssueConstrainerEnablersBySearch(IssueEnablerQuery issueConstrainerEnablerQuery, IssueConstrainerEnablerSearch issueConstrainerEnablerSearch) throws OperationFailedException, PermissionDeniedException
      Gets the search results matching the given search query using the given search.
      Parameters:
      issueConstrainerEnablerQuery - the issue constrainer enabler query
      issueConstrainerEnablerSearch - the issue constrainer enabler search
      Returns:
      the returned search results
      Throws:
      NullArgumentException - issueConstrainerEnablerQuery or issueConstrainerEnablerSearch is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - issueConstrainerEnablerQuery or issueConstrainerEnablerSearch is not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getIssueConstrainerEnablerQueryFromInspector

      IssueConstrainerEnablerQuery getIssueConstrainerEnablerQueryFromInspector(IssueConstrainerEnablerQueryInspector issueConstrainerEnablerQueryInspector)
      Gets an issue constrainer enabler query from an inspector. The inspector is available from an IssueConstrainerEnablerSearchResults .
      Parameters:
      issueConstrainerEnablerQueryInspector - an issue constrainer enabler query inspector
      Returns:
      the issue constrainer enabler query
      Throws:
      NullArgumentException - issueConstrainerEnablerQueryInspector is null
      UnsupportedException - issueConstrainerEnablerQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.