Interface RuleLookupSession

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

This session provides methods for retrieving Rules .

This session defines views that offer differing behaviors when retrieving multiple objects.

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete set or is an error condition
  • isolated engine view: All rule methods in this session operate, retrieve and pertain to rules defined explicitly in the current engine.
  • federated engine view: All rule methods in this session operate, retrieve and pertain to all rules defined in this engine and any other rules implicitly available in this engine through engine inheritence.
  • active rule view: All rule lookup methods return active rules.
  • any status rule view: Rules of any active or inactive status are returned from methods.

Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. For example, a browsing application may only need to examine the Rules it can access, without breaking execution. However, an assessment may only be useful if all Rules referenced by it are available, and a test-taking applicationmay sacrifice some interoperability for the sake of precision.

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

    • canLookupRules

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

    • useComparativeRuleView

      void useComparativeRuleView()
      The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.
      Compliance:
      mandatory - This method is must be implemented.

    • usePlenaryRuleView

      void usePlenaryRuleView()
      A complete view of the Rule returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.
      Compliance:
      mandatory - This method is 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.

    • useActiveRuleView

      void useActiveRuleView()
      Only active rules are returned by methods in this session.
      Compliance:
      mandatory - This method is must be implemented.

    • useAnyStatusRuleView

      void useAnyStatusRuleView()
      All active and inactive rules are returned by methods in this session.
      Compliance:
      mandatory - This method is must be implemented.

    • getRule

      Rule getRule(Id ruleId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Rule specified by its Id . In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Rule may have a different Id than requested, such as the case where a duplicate Id was assigned to a Rule and retained for compatibility. In active mode, rules are returned that are currently active. In any status mode, active and inactive rules are returned.
      Parameters:
      ruleId - Id of the Rule
      Returns:
      the rule
      Throws:
      NotFoundException - ruleId not found
      NullArgumentException - ruleId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method is must be implemented.

    • getRulesByIds

      RuleList getRulesByIds(IdList ruleIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets a RuleList corresponding to the given IdList . In plenary mode, the returned list contains all of the rules specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible Rules may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, rules are returned that are currently active. In any status mode, active and inactive rules are returned.
      Parameters:
      ruleIds - the list of Ids to retrieve
      Returns:
      the returned Rule list
      Throws:
      NotFoundException - an Id was not found
      NullArgumentException - ruleIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getRulesByGenusType

      RuleList getRulesByGenusType(Type ruleGenusType) throws OperationFailedException, PermissionDeniedException
      Gets a RuleList corresponding to the given rule genus Type which does not include rules of genus types derived from the specified Type . In plenary mode, the returned list contains all known rules or an error results. Otherwise, the returned list may contain only those rules that are accessible through this session. In active mode, rules are returned that are currently active. In any status mode, active and inactive rules are returned.
      Parameters:
      ruleGenusType - a rule genus type
      Returns:
      the returned Rule list
      Throws:
      NullArgumentException - ruleGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getRulesByParentGenusType

      RuleList getRulesByParentGenusType(Type ruleGenusType) throws OperationFailedException, PermissionDeniedException
      Gets a RuleList corresponding to the given rule genus Type and include any additional rules with genus types derived from the specified Type . In plenary mode, the returned list contains all known rules or an error results. Otherwise, the returned list may contain only those rules that are accessible through this session. In active mode, rules are returned that are currently active. In any status mode, active and inactive rules are returned.
      Parameters:
      ruleGenusType - a rule genus type
      Returns:
      the returned Rule list
      Throws:
      NullArgumentException - ruleGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getRulesByRecordType

      RuleList getRulesByRecordType(Type ruleRecordType) throws OperationFailedException, PermissionDeniedException
      Gets a RuleList containing the given repository record Type . In plenary mode, the returned list contains all known rules or an error results. Otherwise, the returned list may contain only those rules that are accessible through this session. In active mode, rules are returned that are currently active. In any status mode, active and inactive rules are returned.
      Parameters:
      ruleRecordType - a rule record type
      Returns:
      the returned Rule list
      Throws:
      NullArgumentException - ruleRecordType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getRules

      RuleList getRules() throws OperationFailedException, PermissionDeniedException
      Gets all Rules . In plenary mode, the returned list contains all known rules or an error results. Otherwise, the returned list may contain only those rules that are accessible through this session. In active mode, rules are returned that are currently active. In any status mode, active and inactive rules are returned.
      Returns:
      a list of Rules
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.