Interface InputEnablerRuleLookupSession

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

This session provides methods to retrieve InputEnabler to Input mappings. An Input with multiple InputEnablers means any positive rule evaluation across the enablers result in an effective Input .

This lookup session defines several views:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition
  • isolated system view: All methods in this session operate, retrieve and pertain input enablers defined explicitly in the current system
  • federated system view: All methods in this session operate, retrieve and pertain to all input enablers defined in this system and any other input enablers implicitly available in this system through system inheritence.

  • Method Details

    • getSystemId

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

    • getSystem

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

    • canLookupInputEnablerRules

      boolean canLookupInputEnablerRules()
      Tests if this user can perform lookups of input enabler/input mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 looking up mappings is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useComparativeInputEnablerRuleView

      void useComparativeInputEnablerRuleView()
      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.

    • usePlenaryInputEnablerRuleView

      void usePlenaryInputEnablerRuleView()
      A complete view of the InputEnabler and Input 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.

    • useFederatedSystemView

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

    • useIsolatedSystemView

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

    • getInputEnablerIdsForInput

      IdList getInputEnablerIdsForInput(Id inputId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the InputEnabler Id associated with an Input .
      Parameters:
      inputId - Id of the Input
      Returns:
      the input enabler Ids
      Throws:
      NotFoundException - inputId is not found
      NullArgumentException - inputId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getInputEnablersForInput

      InputEnablerList getInputEnablersForInput(Id inputId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the InputEnabler associated with an Input .
      Parameters:
      inputId - Id of the Input
      Returns:
      the input enablers
      Throws:
      NotFoundException - inputId is not found
      NullArgumentException - inputId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getInputIdsForInputEnabler

      IdList getInputIdsForInputEnabler(Id inputEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Input Ids mapped to an InputEnabler .
      Parameters:
      inputEnablerId - Id of an InputEnabler
      Returns:
      list of input Ids
      Throws:
      NotFoundException - inputEnablerId is not found
      NullArgumentException - inputEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getInputsForInputEnabler

      InputList getInputsForInputEnabler(Id inputEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Inputs mapped to an InputEnabler .
      Parameters:
      inputEnablerId - Id of an InputEnabler
      Returns:
      list of inputs
      Throws:
      NotFoundException - inputEnablerId is not found
      NullArgumentException - inputEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.