Interface IssueProcessorSmartOublietteSession

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

This session manages queries and sequencing to create "smart" dynamic catalogs. An IssueProcessorQuery can be retrieved from this session and mapped to this Oubliette to create a virtual collection of IssueProcessors . The issue processors may be sequenced using the IssueProcessorSearchOrder from this session.

This Oubliette has a default query that matches any issue processor and a default search order that specifies no sequencing. The queries may be examined using an IssueProcessorQueryInspector . The query may be modified by converting the inspector back to an IssueProcessorQuery .

  • Method Details

    • getOublietteId

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

    • getOubliette

      OublietteList getOubliette() throws OperationFailedException, PermissionDeniedException
      Gets the Oubliette associated with this session.
      Returns:
      the oubliette
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canManageSmartIssueProcessors

      boolean canManageSmartIssueProcessors()
      Tests if this user can manage smart issue processors.. 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 oubliette management is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getIssueProcessorQuery

      IssueProcessorQuery getIssueProcessorQuery()
      Gets an issue processor query.
      Returns:
      the issue processor query
      Compliance:
      mandatory - This method must be implemented.

    • getIssueProcessorSearchOrder

      IssueProcessorSearchOrder getIssueProcessorSearchOrder()
      Gets an issue processor search order.
      Returns:
      the issue processor search order
      Compliance:
      mandatory - This method must be implemented.

    • applyIssueProcessorQuery

      void applyIssueProcessorQuery(IssueProcessorQuery issueProcessorQuery) throws OperationFailedException, PermissionDeniedException
      Applies an issue processor query to this oubliette.
      Parameters:
      issueProcessorQuery - the issue processor query
      Throws:
      NullArgumentException - issueProcessorQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - issueProcessorQuery not of this service
      Compliance:
      mandatory - This method must be implemented.

    • inspectIssueProcessorQuery

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

    • applyIssueProcessorSequencing

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

    • getIssueProcessorQueryFromInspector

      IssueProcessorQuery getIssueProcessorQueryFromInspector(IssueProcessorQueryInspector issueProcessorQueryInspector)
      Gets an issue processor query from an inspector.
      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.