Interface IssueEnablerSmartOublietteSession

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

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

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

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

    • canManageSmartIssueEnablers

      boolean canManageSmartIssueEnablers()
      Tests if this user can manage smart issue enablers.. 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.

    • getIssueEnablerQuery

      IssueEnablerQuery getIssueEnablerQuery()
      Gets an issue enabler query.
      Returns:
      the issue enabler query
      Compliance:
      mandatory - This method must be implemented.

    • getIssueEnablerSearchOrder

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

    • applyIssueEnablerQuery

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

    • inspectIssueEnablerQuery

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

    • applyIssueEnablerSequencing

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

    • getIssueEnablerQueryFromInspector

      IssueEnablerQuery getIssueEnablerQueryFromInspector(IssueEnablerQueryInspector issueEnablerQueryInspector)
      Gets an issue enabler query from an inspector.
      Parameters:
      issueEnablerQueryInspector - an issue enabler query inspector
      Returns:
      the issue enabler query
      Throws:
      NullArgumentException - issueEnablerQueryInspector is null
      UnsupportedException - issueEnablerQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.