Interface IssueProcessorEnablerSearchSession

All Superinterfaces:
AutoCloseable, Closeable, IssueProcessorEnablerQuerySession, OsidSession, OsidSession
public interface IssueProcessorEnablerSearchSession extends IssueProcessorEnablerQuerySession

This session provides methods for searching among IssueProcessorEnablers . The search query is constructed using the IssueProcessorEnablerQuery .

getIssueProcessorEnablersByQuery() is the basic search method and returns a list of IssueProcessorEnablers . A more advanced search may be performed with getIssueProcessorEnablersBySearch() .It accepts an IssueProcessorEnablerSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getIssueProcessorEnablersBySearch() returns an IssueProcessorEnablerSearchResults that can be used to access the resulting IssueProcessorEnablerList or be used to perform a search within the result set through Is sueProcessorEnablerSearch .

This session defines views that offer differing behaviors for searching.

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

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

  • Method Details

    • getIssueProcessorEnablerSearch

      IssueProcessorEnablerSearch getIssueProcessorEnablerSearch()
      Gets an issue processor enabler search.
      Returns:
      the issue processor enabler search
      Compliance:
      mandatory - This method must be implemented.

    • getIssueProcessorEnablerSearchOrder

      IssueProcessorEnablerSearchOrder getIssueProcessorEnablerSearchOrder()
      Gets an issue processor enabler search order. The IssueProcessorEnablerSearchOrder is supplied to an IssueProcessorEnablerSearch to specify the ordering of results.
      Returns:
      the issue processor enabler search order
      Compliance:
      mandatory - This method must be implemented.

    • getIssueProcessorEnablersBySearch

      IssueProcessorEnablerSearchResults getIssueProcessorEnablersBySearch(IssueProcessorEnablerQuery issueProcessorEnablerQuery, IssueProcessorEnablerSearch issueProcessorEnablerSearch) throws OperationFailedException, PermissionDeniedException
      Gets the search results matching the given search query using the given search.
      Parameters:
      issueProcessorEnablerQuery - the issue processor enabler query
      issueProcessorEnablerSearch - the issue processor enabler search
      Returns:
      the returned search results
      Throws:
      NullArgumentException - issueProcessorEnablerQuery or issueProcessorEnablerSearch is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - issueProcessorEnablerQuery or issueProcessorEnablerSearch is not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getIssueProcessorEnablerQueryFromInspector

      IssueProcessorEnablerQuery getIssueProcessorEnablerQueryFromInspector(IssueProcessorEnablerQueryInspector issueProcessorEnablerQueryInspector)
      Gets an issue processor enabler query from an inspector. The inspector is available from an IssueProcessorEnablerSearchResults .
      Parameters:
      issueProcessorEnablerQueryInspector - an issue processor enabler query inspector
      Returns:
      the issue processor enabler query
      Throws:
      NullArgumentException - issueProcessorEnablerQueryInspector is null
      UnsupportedException - issueProcessorEnablerQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.