Interface IssueProcessorSearchSession

All Superinterfaces:
AutoCloseable, Closeable, IssueProcessorQuerySession, OsidSession, OsidSession
public interface IssueProcessorSearchSession extends IssueProcessorQuerySession

This session provides methods for searching among IssueProcessors . The search query is constructed using the IssueProcessorQuery .

getIssueProcessorsByQuery() is the basic search method and returns a list of IssueProcessors . A more advanced search may be performed with getIssueProcessorsBySearch() . It accepts an IssueProcessorSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getIssueProcessorsBySearch() returns an IssueProcessorSearchResults that can be used to access the resulting IssueProcessorList or be used to perform a search within the result set through IssueProcessorSearch . This session defines views that offer differing behaviors for searching .
  • federated oubliette view: searches include issue processors in oubliettes of which this oubliette is an ancestor in the oubliette hierarchy
  • isolated oubliette view: searches are restricted to issue processors in this oubliette

Issue processors may have a query record indicated by their respective record types. The query record is accessed via the IssueProcessorQuery .

  • Method Details

    • getIssueProcessorSearch

      IssueProcessorSearch getIssueProcessorSearch()
      Gets an issue processor search.
      Returns:
      the issue processor search
      Compliance:
      mandatory - This method must be implemented.

    • getIssueProcessorSearchOrder

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

    • getIssueProcessorBySearch

      IssueProcessorSearchResults getIssueProcessorBySearch(IssueProcessorQuery issueProcessorQuery, IssueProcessorSearch issueProcessorSearch) throws OperationFailedException, PermissionDeniedException
      Gets the search results matching the given search query using the given search.
      Parameters:
      issueProcessorQuery - the issue processor query
      issueProcessorSearch - the issue processor search
      Returns:
      the returned search results
      Throws:
      NullArgumentException - issueProcessorQuery or issueProcessorSearch is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - issueProcessorQuery or issueProcessorSearch is not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getIssueProcessorQueryFromInspector

      IssueProcessorQuery getIssueProcessorQueryFromInspector(IssueProcessorQueryInspector issueProcessorQueryInspector)
      Gets an issue processor query from an inspector. The inspector is available from an IssueProcessorSearchResults .
      Parameters:
      issueProcessorQueryInspector - an issue processor query inspector
      Returns:
      the issue processor query
      Throws:
      NullArgumentException - issueProcessorQueryInspector is null
      UnsupportedException - issueProcessorQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.