Interface IssueSmartFrontOfficeSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
public interface IssueSmartFrontOfficeSession extends OsidSession

This session manages queries and sequencing to create "smart" dynamic catalogs. An IssueQuery can be retrieved from this session and mapped to this FrontOffice to create a virtual collection of Issues . The issues may be sequenced using the IssueSearchOrder from this session.

This FrontOffice has a default query that matches any issue and a default search order that specifies no sequencing. The queries may be examined using an IssueQueryInspector . The query may be modified by converting the inspector back to an 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.

    • canManageSmartFrontOffices

      boolean canManageSmartFrontOffices()
      Tests if this user can manage smart frontOffices. A return of true does not guarantee successful authorization. A return of false indicates that it is known methods in this session will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer operations to unauthorized users.
      Returns:
      false if smart front office management is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getIssueQuery

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

    • getIssueSearchOrder

      IssueSearchOrder getIssueSearchOrder()
      Gets an issue search order.
      Returns:
      the issue search order
      Compliance:
      mandatory - This method must be implemented.

    • applyIssueQuery

      void applyIssueQuery(IssueQuery issueQuery) throws OperationFailedException, PermissionDeniedException
      Applies an issue query to this front office.
      Parameters:
      issueQuery - the issue query
      Throws:
      NullArgumentException - issueQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - issueQuery not of this service
      Compliance:
      mandatory - This method must be implemented.

    • inspecIssueQuery

      IssueQueryInspector inspecIssueQuery() throws OperationFailedException, PermissionDeniedException
      Gets an issue query inspector for this front office.
      Returns:
      the issue query inspector
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      Compliance:
      mandatory - This method must be implemented.

    • applyIssueSequencing

      void applyIssueSequencing(IssueSearchOrder issueSearchOrder) throws OperationFailedException, PermissionDeniedException
      Applies an issue search order to this front office.
      Parameters:
      issueSearchOrder - the issue search order
      Throws:
      NullArgumentException - issueSearchOrder is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - issueSearchOrder not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getIssueQueryFromInspector

      IssueQuery getIssueQueryFromInspector(IssueQueryInspector issueQueryInspector)
      Gets an issue query from an inspector.
      Parameters:
      issueQueryInspector - an issue query inspector
      Returns:
      the issue query
      Throws:
      NullArgumentException - issueQueryInspector is null
      UnsupportedException - issueQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.