Interface HoldEnablerSmartOublietteSession

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

This session manages queries and sequencing to create "smart" dynamic oubliettes. A HoldEnablerQuery can be retrieved from this session and mapped to this Oubliette to create a virtual collection of hold enablers. The hold enablers may be sequenced using the HoldEnablerSearchOrder from this session.

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

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

    • getHoldEnablerQuery

      HoldEnablerQuery getHoldEnablerQuery()
      Gets a hold enabler query.
      Returns:
      the hold enabler query
      Compliance:
      mandatory - This method must be implemented.

    • getHoldEnablerSearchOrder

      HoldEnablerSearchOrder getHoldEnablerSearchOrder()
      Gets a hold enabler search order.
      Returns:
      the hold enabler search order
      Compliance:
      mandatory - This method must be implemented.

    • applyHoldEnablerQuery

      void applyHoldEnablerQuery(HoldEnablerQuery holdEnablerQuery) throws OperationFailedException, PermissionDeniedException
      Applies a hold enabler query to this oubliette.
      Parameters:
      holdEnablerQuery - the hold enabler query
      Throws:
      NullArgumentException - holdEnablerQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - holdEnablerQuery not of this service
      Compliance:
      mandatory - This method must be implemented.

    • inspectHoldEnablerQuery

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

    • applyHoldEnablerSequencing

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

    • getHoldEnablerQueryFromInspector

      HoldEnablerQuery getHoldEnablerQueryFromInspector(HoldEnablerQueryInspector holdEnablerQueryInspector)
      Gets a hold enabler query from an inspector.
      Parameters:
      holdEnablerQueryInspector - a hold enabler query inspector
      Returns:
      the hold enabler query
      Throws:
      NullArgumentException - holdEnablerQueryInspector is null
      UnsupportedException - holdEnablerQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.