Interface IssueConstrainerSmartOublietteSession

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

This session manages queries and sequencing to create "smart" dynamic catalogs. An IssueConstrainerQu ery can be retrieved from this session and mapped to this Oubliette to create a virtual collection of IssueConstraine rs. The issue constrainers may be sequenced using the IssueConstrainerSearchOr der from this session.

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

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

    • canManageSmartIssueConstrainers

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

    • getIssueConstrainerQuery

      IssueConstrainerQuery getIssueConstrainerQuery()
      Gets an issue constrainer query.
      Returns:
      the issue constrainer query
      Compliance:
      mandatory - This method must be implemented.

    • getIssueConstrainerSearchOrder

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

    • applyIssueConstrainerQuery

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

    • inspectIssueConstrainerQuery

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

    • applyIssueConstrainerSequencing

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

    • getIssueConstrainerQueryFromInspector

      IssueConstrainerQuery getIssueConstrainerQueryFromInspector(IssueConstrainerQueryInspector issueConstrainerQueryInspector)
      Gets an issue constrainer query from an inspector.
      Parameters:
      issueConstrainerQueryInspector - an issue constrainer query inspector
      Returns:
      the issue constrainer query
      Throws:
      NullArgumentException - issueConstrainerQueryInspector is null
      UnsupportedException - issueConstrainerQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.