Interface IssueProcessorEnablerSmartOublietteSession

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

This session manages queries and sequencing to create "smart" dynamic catalogs. An IssueProcessorEnablerQuery can be retrieved from this session and mapped to this Oubliette to create a virtual collection of IssueProcessorEnablers . The issue processor enablers may be sequenced using the IssueProcessorEnablerSearchOrder from this session.

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

  • 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

      Oubliette 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.

    • canManageSmartOubliettes

      boolean canManageSmartOubliettes()
      Tests if this user can manage smart oubliettes. 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.

    • getIssueProcessorEnablerQuery

      IssueProcessorEnablerQuery getIssueProcessorEnablerQuery()
      Gets an issue processor enabler query.
      Returns:
      the issue processor enabler query
      Compliance:
      mandatory - This method must be implemented.

    • getIssueProcessorEnablerSearchOrder

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

    • applyIssueProcessorEnablerQuery

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

    • inspectIssueProcessorEnablerQuery

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

    • applyIssueProcessorEnablerSequencing

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

    • getIssueProcessorEnablerQueryFromInspector

      IssueProcessorEnablerQuery getIssueProcessorEnablerQueryFromInspector(IssueProcessorEnablerQueryInspector issueProcessorEnablerQueryInspector)
      Gets an issue processor enabler query from an inspector.
      Parameters:
      issueProcessorEnablerQueryInspector - an issue processor enabler query inspector
      Returns:
      the issue processor enabler query
      Throws:
      NullArgumentException - issueProcessorEnablerQueryInspector is null
      UnsupportedException - issueProcessorEnablerQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.