Interface IssueQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
IssueSearchSession
public interface IssueQuerySession extends OsidSession

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

This session defines views that offer differing behaviors for searching.

  • federated front office view: searches include issues in front offices of which this front office is an ancestor in the front office hierarchy
  • isolated front office view: searches are restricted to issues in this frontOffice

Issues may have a query record indicated by their respective record types. The record query is accessed via the IssueQuery .

  • Method Details

    • getFrontOfficeId

      Id getFrontOfficeId()
      Gets the FrontOffice Id associated with this session.
      Returns:
      the FrontOffice Id associated with this session
      Compliance:
      mandatory - This method must be implemented.

    • getFrontOffice

      FrontOffice getFrontOffice() throws OperationFailedException, PermissionDeniedException
      Gets the FrontOffice associated with this session.
      Returns:
      the front office
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canSearchIssues

      boolean canSearchIssues()
      Tests if this user can perform Issue lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED . This is intended as a hint to an application that may not offer lookup operations to unauthorized users.
      Returns:
      false if search methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useFederatedFrontOfficeView

      void useFederatedFrontOfficeView()
      Federates the view for methods in this session. A federated view will include issues in front offices which are children of this front office in the front office hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedFrontOfficeView

      void useIsolatedFrontOfficeView()
      Isolates the view for methods in this session. An isolated view restricts lookups to this front office only.
      Compliance:
      mandatory - This method is must be implemented.

    • getIssueQuery

      IssueQuery getIssueQuery()
      Gets an issue query.
      Returns:
      the issue query
      Compliance:
      mandatory - This method must be implemented.

    • getIssuesByQuery

      IssueList getIssuesByQuery(IssueQuery issueQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of Issues matching the given issue query.
      Parameters:
      issueQuery - the issue query
      Returns:
      the returned IssueList
      Throws:
      NullArgumentException - issueQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - issueQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.