Interface CanonicalUnitEnablerRuleLookupSession

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

This session provides methods to retrieve CanonicalUnitEnabler to CanonicalUnit mappings. A CanonicalUnit with multiple CanonicalUnitEnablers means any positive rule evaluation across the enablers result in an effective CanonicalUnit .

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 catalogue view: All methods in this session operate, retrieve and pertain canonical unit enablers defined explicitly in the current catalogue
  • federated catalogue view: All methods in this session operate, retrieve and pertain to all canonical unit enablers defined in this catalogue and any other canonical unit enablers implicitly available in this catalogue through catalogue inheritence.

  • Method Details

    • getCatalogueId

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

    • getCatalogue

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

    • canLookupCanonicalUnitEnablerRules

      boolean canLookupCanonicalUnitEnablerRules()
      Tests if this user can perform lookups of canonical unit enabler/canonical unit 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.

    • useComparativeCanonicalUnitEnablerRuleView

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

    • usePlenaryCanonicalUnitEnablerRuleView

      void usePlenaryCanonicalUnitEnablerRuleView()
      A complete view of the CanonicalUnitEnabler and CanonicalUnit 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.

    • useFederatedCatalogueView

      void useFederatedCatalogueView()
      Federates the view for methods in this session. A federated view will include canonical unit enablers in catalogues which are children of this catalogue in the catalogue hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedCatalogueView

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

    • getCanonicalUnitEnablerIdsForCanonicalUnit

      IdList getCanonicalUnitEnablerIdsForCanonicalUnit(Id canonicalUnitId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the CanonicalUnitEnabler Id associated with a CanonicalUnit .
      Parameters:
      canonicalUnitId - Id of the CanonicalUnit
      Returns:
      the canonical unit enabler Ids
      Throws:
      NotFoundException - canonicalUnitId is not found
      NullArgumentException - canonicalUnit is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getCanonicalUnitEnablersForCanonicalUnit

      CanonicalUnitEnablerList getCanonicalUnitEnablersForCanonicalUnit(Id canonicalUnitId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the CanonicalUnitEnablers associated with a CanonicalUnit .
      Parameters:
      canonicalUnitId - Id of the CanonicalUnit
      Returns:
      the canonical unit enablers
      Throws:
      NotFoundException - canonicalUnitId is not found
      NullArgumentException - canonicalUnitId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getCanonicalUnitIdsForCanonicalUnitEnabler

      IdList getCanonicalUnitIdsForCanonicalUnitEnabler(Id canonicalUnitEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the CanonicalUnit Ids mapped to a CanonicalUnitEnabler .
      Parameters:
      canonicalUnitEnablerId - Id of a CanonicalUnitEnabler
      Returns:
      list of canonical unit Ids
      Throws:
      NotFoundException - canonicalUnitEnablerId is not found
      NullArgumentException - canonicalUnitEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getCanonicalUnitsForCanonicalUnitEnabler

      CanonicalUnitList getCanonicalUnitsForCanonicalUnitEnabler(Id canonicalUnitEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the CanonicalUnits mapped to a CanonicalUnitEnabler .
      Parameters:
      canonicalUnitEnablerId - Id of a CanonicalUnitEnabler
      Returns:
      list of canonical units
      Throws:
      NotFoundException - canonicalUnitEnablerId is not found
      NullArgumentException - canonicalUnitEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.