Interface OfferingConstrainerEnablerCatalogueSession

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

This session provides methods to retrieve OfferingConstrainerEnabler to Catalogue mappings. An OfferingConstrainerEnabler 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

    • canLookupOfferingConstrainerEnablerCatalogueMappings

      boolean canLookupOfferingConstrainerEnablerCatalogueMappings()
      Tests if this user can perform lookups of offering constrainer 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.

    • useComparativeOfferingConstrainerEnablerCatalogueView

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

    • usePlenaryOfferingConstrainerEnablerCatalogueView

      void usePlenaryOfferingConstrainerEnablerCatalogueView()
      A complete view of the OfferingConstrainerEnabler 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.

    • getOfferingConstrainerEnablerIdsByCatalogue

      IdList getOfferingConstrainerEnablerIdsByCatalogue(Id catalogueId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the list of OfferingConstrainerEnablerIds associated with a Catalogue .
      Parameters:
      catalogueId - Id of the Catalogue
      Returns:
      list of related offering constrainer 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.

    • getOfferingConstrainerEnablersByCatalogue

      OfferingConstrainerEnablerList getOfferingConstrainerEnablersByCatalogue(Id catalogueId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the list of offering constrainer enablers associated with a Catalogue .
      Parameters:
      catalogueId - Id of the Catalogue
      Returns:
      list of related offering constrainer 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.

    • getOfferingConstrainerEnablerIdsByCatalogues

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

    • getOfferingConstrainerEnablersByCatalogues

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

    • getCatalogueIdsByOfferingConstrainerEnabler

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

    • getCataloguesByOfferingConstrainerEnabler

      CatalogueList getCataloguesByOfferingConstrainerEnabler(Id offeringConstrainerEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Catalogues mapped to an OfferingConstrainerEnabler .
      Parameters:
      offeringConstrainerEnablerId - Id of an OfferingConstrainerEnabler
      Returns:
      list of catalogues
      Throws:
      NotFoundException - offeringConstrainerEnablerId is not found
      NullArgumentException - offeringConstrainerEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.