Interface CanonicalUnitProcessorEnablerCatalogueSession

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

This session provides methods to retrieve CanonicalUnitProcessorEnabler to Catalogue mappings. A CanonicalUnitProcessorEnabler may appear in multiple Catalogue objects. Each catalogue may have its own authorizations governing who is allowed to look at it.

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

  • Method Details

    • canLookupCanonicalUnitProcessorEnablerCatalogueMappings

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

    • useComparativeCanonicalUnitProcessorEnablerCatalogueView

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

    • usePlenaryCanonicalUnitProcessorEnablerCatalogueView

      void usePlenaryCanonicalUnitProcessorEnablerCatalogueView()
      A complete view of the CanonicalUnitProcessorEnabler and Catalogue 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.

    • getCanonicalUnitProcessorEnablerIdsByCatalogue

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

    • getCanonicalUnitProcessorEnablersByCatalogue

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

    • getCanonicalUnitProcessorEnablerIdsByCatalogues

      IdList getCanonicalUnitProcessorEnablerIdsByCatalogues(IdList catalogueIds) throws OperationFailedException, PermissionDeniedException
      Gets the list of CanonicalUnitProcessorEnablerIds corresponding to a list of Catalogues .
      Parameters:
      catalogueIds - list of catalogue Ids
      Returns:
      list of canonical unit processor enabler Ids
      Throws:
      NullArgumentException - catalogueIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getCanonicalUnitProcessorEnablersByCatalogues

      CanonicalUnitProcessorEnablerList getCanonicalUnitProcessorEnablersByCatalogues(IdList catalogueIds) throws OperationFailedException, PermissionDeniedException
      Gets the list of canonical unit processor enablers corresponding to a list of Catalogues .
      Parameters:
      catalogueIds - list of catalogue Ids
      Returns:
      list of canonical unit processor enablers
      Throws:
      NullArgumentException - catalogueIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getCatalogueIdsByCanonicalUnitProcessorEnabler

      IdList getCatalogueIdsByCanonicalUnitProcessorEnabler(Id canonicalUnitProcessorEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Catalogue Ids mapped to a CanonicalUnitProcessorEnabler .
      Parameters:
      canonicalUnitProcessorEnablerId - Id of a CanonicalUnitProcessorEnabler
      Returns:
      list of catalogues
      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.

    • getCataloguesByCanonicalUnitProcessorEnabler

      CatalogueList getCataloguesByCanonicalUnitProcessorEnabler(Id canonicalUnitProcessorEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Catalogues mapped to a CanonicalUnitProcessorEnabler .
      Parameters:
      canonicalUnitProcessorEnablerId - Id of a CanonicalUnitProcessorEnabler
      Returns:
      list of catalogues
      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.