Interface IssueConstrainerSearchSession

All Superinterfaces:
AutoCloseable, Closeable, IssueConstrainerQuerySession, OsidSession, OsidSession
public interface IssueConstrainerSearchSession extends IssueConstrainerQuerySession

This session provides methods for searching among IssueConstrainers . The search query is constructed using the IssueConstrainerQuery .

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

This session defines views that offer differing behaviors for searching.

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

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

  • Method Details

    • getIssueConstrainerSearch

      IssueConstrainerSearch getIssueConstrainerSearch()
      Gets an issue constrainer search.
      Returns:
      the issue constrainer search
      Compliance:
      mandatory - This method must be implemented.

    • getIssueConstrainerSearchOrder

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

    • getIssueConstrainerBySearch

      IssueConstrainerSearchResults getIssueConstrainerBySearch(IssueConstrainerQuery issueConstrainerQuery, IssueConstrainerSearch issueConstrainerSearch) throws OperationFailedException, PermissionDeniedException
      Gets the search results matching the given search query using the given search.
      Parameters:
      issueConstrainerQuery - the issue constrainer query
      issueConstrainerSearch - the issue constrainer search
      Returns:
      the returned search results
      Throws:
      NullArgumentException - issueConstrainerQuery or issueConstrainerSearch is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - issueConstrainerQuery or issueConstrainerSearch is not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getIssueConstrainerQueryFromInspector

      IssueConstrainerQuery getIssueConstrainerQueryFromInspector(IssueConstrainerQueryInspector issueConstrainerQueryInspector)
      Gets an issue constrainer query from an inspector. The inspector is available from an IssueConstrainerSearchResults .
      Parameters:
      issueConstrainerQueryInspector - an issue constrainer query inspector
      Returns:
      the issue constrainer query
      Throws:
      NullArgumentException - issueConstrainerQueryInspector is null
      UnsupportedException - issueConstrainerQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.