Interface CanonicalUnitProcessorEnablerRuleLookupSession

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

This session provides methods to retrieve CanonicalUnitProcessorEnabler to CanonicalUnitProcessor mappings. A CanonicalUnitProcessor with multiple CanonicalUnitProcessorEnablers means any positive rule evaluation across the enablers result in an effective CanonicalUnitProcessor .

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

    • canLookupCanonicalUnitProcessorEnablerRules

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

    • useComparativeCanonicalUnitProcessorEnablerRuleView

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

    • usePlenaryCanonicalUnitProcessorEnablerRuleView

      void usePlenaryCanonicalUnitProcessorEnablerRuleView()
      A complete view of the CanonicalUnitProcessorEnabler and CanonicalUnitProcessor 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 processor 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.

    • getCanonicalUnitProcessorEnablerIdsForCanonicalUnitProcessor

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

    • getCanonicalUnitProcessorEnablersForCanonicalUnitProcessor

      CanonicalUnitProcessorEnablerList getCanonicalUnitProcessorEnablersForCanonicalUnitProcessor(Id canonicalUnitProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the CanonicalUnitProcessorEnabler associated with a CanonicalUnitProcessor .
      Parameters:
      canonicalUnitProcessorId - Id of the CanonicalUnitProcessor
      Returns:
      the canonical unit processor enablers
      Throws:
      NotFoundException - canonicalUnitProcessorId is not found
      NullArgumentException - canonicalUnitProcessorId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getCanonicalUnitProcessorIdsForCanonicalUnitProcessorEnabler

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

    • getCanonicalUnitProcessorsForCanonicalUnitProcessorEnabler

      CanonicalUnitProcessorList getCanonicalUnitProcessorsForCanonicalUnitProcessorEnabler(Id canonicalUnitProcessorEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the CanonicalUnitProcessors mapped to a CanonicalUnitProcessorEnabler .
      Parameters:
      canonicalUnitProcessorEnablerId - Id of a CanonicalUnitProcessorEnabler
      Returns:
      list of canonical unit processors
      Throws:
      NotFoundException - canonicalUnitProcessorEnablerId is not found
      NullArgumentException - canonicalUnitProcessorEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.