Interface OfferingConstrainerCatalogueSession

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

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

    • canLookupOfferingConstrainerCatalogueMappings

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

    • useComparativeOfferingConstrainerCatalogueView

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

    • usePlenaryOfferingConstrainerCatalogueView

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

    • getOfferingConstrainerIdsByCatalogue

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

    • getOfferingConstrainersByCatalogue

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

    • getOfferingConstrainerIdsByCatalogues

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

    • getOfferingConstrainersByCatalogues

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

    • getCatalogueIdsByOfferingConstrainer

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

    • getCataloguesByOfferingConstrainer

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