Interface RuleQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
RuleSearchSession
public interface RuleQuerySession extends OsidSession

This session provides methods for searching Rules. The search query is constructed using the RuleQuery. The rule record Type also specifies the record for the rule query.

Rules may have a rule query record indicated by their respective record types. The rule query record is accessed via the RuleQuery. The returns in this session may not be cast directly to these interfaces.

  • Method Details

    • getEngineId

      Id getEngineId()
      Gets the Engine Id associated with this session.
      Returns:
      the Engine Id associated with this session
      Compliance:
      mandatory - This method must be implemented.

    • getEngine

      Engine getEngine() throws OperationFailedException, PermissionDeniedException
      Gets the Engine associated with this session.
      Returns:
      the engine
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • useFederatedEngineView

      void useFederatedEngineView()
      Federates the view for methods in this session. A federated view will include rules in engines which are children of this engine in the engine hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedEngineView

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

    • canSearchRules

      boolean canSearchRules()
      Tests if this user can perform Rule searches. 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 opt not to offer search operations to unauthorized users.
      Returns:
      false if search methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getRuleQuery

      RuleQuery getRuleQuery()
      Gets a rule query.
      Returns:
      the rule query
      Compliance:
      mandatory - This method must be implemented.

    • getRulesByQuery

      RuleList getRulesByQuery(RuleQuery ruleQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of Rules matching the given rule query.
      Parameters:
      ruleQuery - the rule query
      Returns:
      the returned RuleList
      Throws:
      NullArgumentException - ruleQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - ruleQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.