Interface HoldEnablerQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
HoldEnablerSearchSession
public interface HoldEnablerQuerySession extends OsidSession

This session provides methods for searching among HoldEnabler objects. The search query is constructed using the HoldEnablerQuery.

This session defines views that offer differing behaviors for searching.

  • federated oubliette view: searches include hold enablers in oubliettes of which this oubliette is an ancestor in the oubliette hierarchy
  • isolated oubliette view: searches are restricted to hold enablers in this oubliette

Hold enablers may have a query record indicated by their respective record types. The query record is accessed via the 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.

    • canSearchHoldEnablers

      boolean canSearchHoldEnablers()
      Tests if this user can perform HoldEnabler lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may not offer lookup operations to unauthorized users.
      Returns:
      false if search methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useFederatedOublietteView

      void useFederatedOublietteView()
      Federates the view for methods in this session. A federated view will include hold enablers in oubliettes which are children of this oubliette in the oubliette hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedOublietteView

      void useIsolatedOublietteView()
      Isolates the view for methods in this session. An isolated view restricts lookups to this oubliette only.
      Compliance:
      mandatory - This method is must be implemented.

    • getHoldEnablerQuery

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

    • getHoldEnablersByQuery

      HoldEnablerList getHoldEnablersByQuery(HoldEnablerQuery holdEnablerQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of HoldEnablers matching the given hold enabler query.
      Parameters:
      holdEnablerQuery - the hold enabler query
      Returns:
      the returned HoldEnablerList
      Throws:
      NullArgumentException - holdEnablerQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - holdEnablerQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.