Interface IssueConstrainerEnablerSmartOublietteSession

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

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

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

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

    • getIssueConstrainerEnablerQuery

      IssueConstrainerEnablerQuery getIssueConstrainerEnablerQuery()
      Gets an issue constrainer enabler query.
      Returns:
      the issue constrainer enabler query
      Compliance:
      mandatory - This method must be implemented.

    • getIssueConstrainerEnablerSearchOrder

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

    • applyIssueConstrainerEnablerQuery

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

    • inspectIssueConstrainerEnablerQuery

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

    • applyIssueConstrainerEnablerSequencing

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

    • getIssueConstrainerEnablerQueryFromInspector

      IssueConstrainerEnablerQuery getIssueConstrainerEnablerQueryFromInspector(IssueConstrainerEnablerQueryInspector issueConstrainerEnablerQueryInspector)
      Gets an issue constrainer enabler query from an inspector.
      Parameters:
      issueConstrainerEnablerQueryInspector - an issue constrainer enabler query inspector
      Returns:
      the issue constrainer enabler query
      Throws:
      NullArgumentException - issueConstrainerEnablerQueryInspector is null
      UnsupportedException - issueConstrainerEnablerQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.