Interface OfferingRulesManager

All Superinterfaces:
AutoCloseable, Closeable, OfferingRulesProfile, OsidManager, OsidManager, OsidProfile, Sourceable
public interface OfferingRulesManager extends OsidManager, OfferingRulesProfile

The offering rules manager provides access to offering rules sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:

  • CanonicalUnitEnablerLookupSession : a session to retrieve canonical unit enablers
  • CanonicalUnitEnablerQuerySession : a session to query for canonical unit enablers
  • CanonicalUnitEnablerSearchSession : a session to search for canonical unit enablers
  • CanonicalUnitEnablerAdminSession : a session to create and delete canonical unit enablers
  • CanonicalUnitEnablerNotificationSession : a session to receive notifications pertaining to canonical unit enabler changes
  • CanonicalUnitEnablerCatalogueSession : a session to look up canonical unit enabler catalogue mappings
  • CanonicalUnitEnablerCatalogueAssignmentSession : a session to manage canonical unit enabler to catalogue mappings
  • CanonicalUnitEnablerSmartCatalogueSession : a session to manage dynamic catalogues of canonical unit enablers
  • CanonicalUnitEnableRuleLookupSession : a session to look up canonical unit enabler mappings
  • CanonicalUnitEnablerRuleApplicationSession : a session to apply canonical unit enablers
  • CanonicalUnitProcessorLookupSession : a session to retrieve canonical unit processor
  • CanonicalUnitProcessorQuerySession : a session to query for canonical unit processor
  • CanonicalUnitProcessorSearchSession : a session to search for canonical unit processor
  • CanonicalUnitProcessorAdminSession : a session to create and delete canonical unit processor
  • CanonicalUnitProcessorNotificationSession : a session to receive notifications pertaining to canonical unit processor changes
  • CanonicalUnitProcessorCatalogueSession : a session to look up canonical unit processor catalogue mappings
  • CanonicalUnitProcessorCatalogueAssignmentSession : a session to manage canonical unit processor to catalogue mappings
  • CanonicalUnitProcessorSmartCatalogueSession : a session to manage dynamic catalogues of canonical unit processor
  • CanonicalUnitProcessorRuleLookupSession : a session to look up canonical unit processor to canonical unit mappings
  • CanonicalUnitProcessorRuleApplicationSession : a session to apply canonical unit processor to canonicalUnits
  • CanonicalUnitProcessorEnablerLookupSession : a session to retrieve canonical unit processor enablers
  • CanonicalUnitProcessorEnablerQuerySession : a session to query for canonical unit processor enablers
  • CanonicalUnitProcessorEnablerSearchSession : a session to search for canonical unit processor enablers
  • CanonicalUnitProcessorEnablerAdminSession : a session to create and delete canonical unit processor enablers
  • CanonicalUnitProcessorEnablerNotificationSession : a session to receive notifications pertaining to canonical unit processor enabler changes
  • CanonicalUnitProcessorEnablerCatalogueSession : a session to look up canonical unit processor enabler catalogue mappings
  • CanonicalUnitProcessorEnablerCatalogueAssignmentSession : a session to manage canonical unit processor enabler to catalogue mappings
  • CanonicalUnitProcessorEnablerSmartCatalogueSession : a session to manage dynamic catalogues of canonical unit processor enablers
  • CanonicalUnitProcessorEnablerRuleLookupSession : a session to look up canonical unit processor enabler mappings
  • CanonicalUnitProcessorEnablerRuleApplicationSession : a session to apply canonical unit processor enablers
  • OfferingConstrainerLookupSession : a session to retrieve offering constrainer
  • OfferingConstrainerQuerySession : a session to query for offering constrainer
  • OfferingConstrainerSearchSession : a session to search for offering constrainer
  • OfferingConstrainerAdminSession : a session to create and delete offering constrainer
  • OfferingConstrainerNotificationSession : a session to receive notifications pertaining to offering constrainer changes
  • OfferingConstrainerCatalogueSession : a session to look up offering constrainer catalogue mappings
  • OfferingConstrainerCatalogueAssignmentSession : a session to manage offering constrainer to catalogue mappings
  • OfferingConstrainerSmartCatalogueSession : a session to manage dynamic catalogues of offering constrainer
  • OfferingConstrainerRuleLookupSession : a session to look up offering constrainer to canonical unit mappings
  • OfferingConstrainerRuleApplicationSession : a session to apply offering constrainer to canonicalUnits
  • OfferingConstrainerEnablerLookupSession : a session to retrieve offering constrainer enablers
  • OfferingConstrainerEnablerQuerySession : a session to query for offering constrainer enablers
  • OfferingConstrainerEnablerSearchSession : a session to search for offering constrainer enablers
  • OfferingConstrainerEnablerAdminSession : a session to create and delete offering constrainer enablers
  • OfferingConstrainerEnablerNotificationSession : a session to receive notifications pertaining to offering constrainer enabler changes
  • OfferingConstrainerEnablerCatalogueSession : a session to look up offering constrainer enabler catalogue mappings
  • OfferingConstrainerEnablerCatalogueAssignmentSession : a session to manage offering constrainer enabler to catalogue mappings
  • OfferingConstrainerEnablerSmartCatalogueSession : a session to manage dynamic catalogues of offering constrainer enablers
  • OfferingConstrainerEnableRuleLookupSession : a session to look up offering constrainer enabler mappings
  • OfferingConstrainerEnablerRuleApplicationSession : a session to apply offering constrainer enablers

  • Method Details

    • getCanonicalUnitEnablerLookupSession

      CanonicalUnitEnablerLookupSession getCanonicalUnitEnablerLookupSession() throws OperationFailedException
      Gets the OsidSession associated with the canonical unit enabler lookup service.
      Returns:
      a CanonicalUnitEnablerLookupSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCanonicalUnitEnablerLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCanonicalUnitEnablerLookup()} is {@code true} .

    • getCanonicalUnitEnablerLookupSessionForCatalogue

      CanonicalUnitEnablerLookupSession getCanonicalUnitEnablerLookupSessionForCatalogue(Id catalogueId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the canonical unit enabler lookup service for the given catalogue.
      Parameters:
      catalogueId - the Id of the Catalogue
      Returns:
      a CanonicalUnitEnablerLookupSession
      Throws:
      NotFoundException - no Catalogue found by the given Id
      NullArgumentException - catalogueId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCanonicalUnitEnablerLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCanonicalUnitEnablerLookup()} and {@code supportsVisibleFederation()} are {@code true} .

    • getCanonicalUnitEnablerQuerySession

      CanonicalUnitEnablerQuerySession getCanonicalUnitEnablerQuerySession() throws OperationFailedException
      Gets the OsidSession associated with the canonical unit enabler query service.
      Returns:
      a CanonicalUnitEnablerQuerySession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCanonicalUnitEnablerQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCanonicalUnitEnablerQuery()} is {@code true} .

    • getCanonicalUnitEnablerQuerySessionForCatalogue

      CanonicalUnitEnablerQuerySession getCanonicalUnitEnablerQuerySessionForCatalogue(Id catalogueId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the canonical unit enabler query service for the given catalogue.
      Parameters:
      catalogueId - the Id of the Catalogue
      Returns:
      a CanonicalUnitEnablerQuerySession
      Throws:
      NotFoundException - no Catalogue found by the given Id
      NullArgumentException - catalogueId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCanonicalUnitEnablerQuery() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCanonicalUnitEnablerQuery()} and {@code supportsVisibleFederation()} are {@code true} .

    • getCanonicalUnitEnablerSearchSession

      CanonicalUnitEnablerSearchSession getCanonicalUnitEnablerSearchSession() throws OperationFailedException
      Gets the OsidSession associated with the canonical unit enabler search service.
      Returns:
      a CanonicalUnitEnablerSearchSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCanonicalUnitEnablerSearch() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCanonicalUnitEnablerSearch()} is {@code true} .

    • getCanonicalUnitEnablerSearchSessionForCatalogue

      CanonicalUnitEnablerSearchSession getCanonicalUnitEnablerSearchSessionForCatalogue(Id catalogueId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the canonical unit enablers earch service for the given catalogue.
      Parameters:
      catalogueId - the Id of the Catalogue
      Returns:
      a CanonicalUnitEnablerSearchSession
      Throws:
      NotFoundException - no Catalogue found by the given Id
      NullArgumentException - catalogueId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCanonicalUnitEnablerSearch() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCanonicalUnitEnablerSearch()} and {@code supportsVisibleFederation()} are {@code true} .

    • getCanonicalUnitEnablerAdminSession

      CanonicalUnitEnablerAdminSession getCanonicalUnitEnablerAdminSession() throws OperationFailedException
      Gets the OsidSession associated with the canonical unit enabler administration service.
      Returns:
      a CanonicalUnitEnablerAdminSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCanonicalUnitEnablerAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCanonicalUnitEnablerAdmin()} is {@code true} .

    • getCanonicalUnitEnablerAdminSessionForCatalogue

      CanonicalUnitEnablerAdminSession getCanonicalUnitEnablerAdminSessionForCatalogue(Id catalogueId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the canonical unit enabler administration service for the given catalogue.
      Parameters:
      catalogueId - the Id of the Catalogue
      Returns:
      a CanonicalUnitEnablerAdminSession
      Throws:
      NotFoundException - no Catalogue found by the given Id
      NullArgumentException - catalogueId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCanonicalUnitEnablerAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCanonicalUnitEnablerAdmin()} and {@code supportsVisibleFederation()} are {@code true} .

    • getCanonicalUnitEnablerNotificationSession

      CanonicalUnitEnablerNotificationSession getCanonicalUnitEnablerNotificationSession(CanonicalUnitEnablerReceiver canonicalUnitEnablerReceiver) throws OperationFailedException
      Gets the OsidSession associated with the canonical unit enabler notification service.
      Parameters:
      canonicalUnitEnablerReceiver - the notification callback
      Returns:
      a CanonicalUnitEnablerNotificationSession
      Throws:
      NullArgumentException - canonicalUnitEnablerReceiver is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCanonicalUnitEnablerNotification() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCanonicalUnitEnablerNotification()} is {@code true} .

    • getCanonicalUnitEnablerNotificationSessionForCatalogue

      CanonicalUnitEnablerNotificationSession getCanonicalUnitEnablerNotificationSessionForCatalogue(CanonicalUnitEnablerReceiver canonicalUnitEnablerReceiver, Id catalogueId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the canonical unit enabler notification service for the given catalogue.
      Parameters:
      canonicalUnitEnablerReceiver - the notification callback
      catalogueId - the Id of the Catalogue
      Returns:
      a CanonicalUnitEnablerNotificationSession
      Throws:
      NotFoundException - no catalogue found by the given Id
      NullArgumentException - canonicalUnitEnablerReceiver or catalogueId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCanonicalUnitEnablerNotification() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCanonicalUnitEnablerNotification()} and {@code supportsVisibleFederation()} are {@code true} .

    • getCanonicalUnitEnablerCatalogueSession

      CanonicalUnitEnablerCatalogueSession getCanonicalUnitEnablerCatalogueSession() throws OperationFailedException
      Gets the OsidSession to lookup canonical unit enabler/catalogue mappings for canonical unit enablers.
      Returns:
      a CanonicalUnitEnablerCatalogueSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCanonicalUnitEnablerCatalogue() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCanonicalUnitEnablerCatalogue()} is {@code true} .

    • getCanonicalUnitEnablerCatalogueAssignmentSession

      CanonicalUnitEnablerCatalogueAssignmentSession getCanonicalUnitEnablerCatalogueAssignmentSession() throws OperationFailedException
      Gets the OsidSession associated with assigning canonical unit enablers to catalogues.
      Returns:
      a CanonicalUnitEnablerCatalogueAssignmentSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCanonicalUnitEnablerCatalogueAssignment() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCanonicalUnitEnablerCatalogueAssignment()} is {@code true} .

    • getCanonicalUnitEnablerSmartCatalogueSession

      CanonicalUnitEnablerSmartCatalogueSession getCanonicalUnitEnablerSmartCatalogueSession(Id catalogueId) throws NotFoundException, OperationFailedException
      Gets the OsidSession to manage canonical unit enabler smart catalogues.
      Parameters:
      catalogueId - the Id of the Catalogue
      Returns:
      a CanonicalUnitEnablerSmartCatalogueSession
      Throws:
      NotFoundException - no Catalogue found by the given Id
      NullArgumentException - catalogueId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCanonicalUnitEnablerSmartCatalogue() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCanonicalUnitEnablerSmartCatalogue()} is {@code true} .

    • getCanonicalUnitEnablerRuleLookupSession

      CanonicalUnitEnablerRuleLookupSession getCanonicalUnitEnablerRuleLookupSession() throws OperationFailedException
      Gets the OsidSession associated with the canonical unit enabler mapping lookup service.
      Returns:
      a CanonicalUnitEnablerRuleLookupSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCanonicalUnitEnablerRuleLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCanonicalUnitEnablerRuleLookup()} is {@code true} .

    • getCanonicalUnitEnablerRuleLookupSessionForCatalogue

      CanonicalUnitEnablerRuleLookupSession getCanonicalUnitEnablerRuleLookupSessionForCatalogue(Id catalogueId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the canonical unit enabler mapping lookup service for the given catalogue.
      Parameters:
      catalogueId - the Id of the Catalogue
      Returns:
      a CanonicalUnitEnablerRuleLookupSession
      Throws:
      NotFoundException - no Catalogue found by the given Id
      NullArgumentException - catalogueId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCanonicalUnitEnablerRuleLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCanonicalUnitEnablerRuleLookup()} and {@code supportsVisibleFederation()} are {@code true} .

    • getCanonicalUnitEnablerRuleApplicationSession

      CanonicalUnitEnablerRuleApplicationSession getCanonicalUnitEnablerRuleApplicationSession() throws OperationFailedException
      Gets the OsidSession associated with the canonical unit enabler assignment service.
      Returns:
      a CanonicalUnitEnablerRuleApplicationSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCanonicalUnitEnablerRuleApplication() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCanonicalUnitEnablerRuleApplication()} is {@code true} .

    • getCanonicalUnitEnablerRuleApplicationSessionForCatalogue

      CanonicalUnitEnablerRuleApplicationSession getCanonicalUnitEnablerRuleApplicationSessionForCatalogue(Id catalogueId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the canonical unit enabler assignment service for the given catalogue.
      Parameters:
      catalogueId - the Id of the Catalogue
      Returns:
      a CanonicalUnitEnablerRuleApplicationSession
      Throws:
      NotFoundException - no Catalogue found by the given Id
      NullArgumentException - catalogueId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCanonicalUnitEnablerRuleApplication() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCanonicalUnitEnablerRuleApplication()} and {@code supportsVisibleFederation()} are {@code true} .

    • getCanonicalUnitProcessorLookupSession

      CanonicalUnitProcessorLookupSession getCanonicalUnitProcessorLookupSession() throws OperationFailedException
      Gets the OsidSession associated with the canonical unit processor lookup service.
      Returns:
      a CanonicalUnitProcessorLookupSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCanonicalUnitProcessorLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCanonicalUnitProcessorLookup()} is {@code true} .

    • getCanonicalUnitProcessorLookupSessionForCatalogue

      CanonicalUnitProcessorLookupSession getCanonicalUnitProcessorLookupSessionForCatalogue(Id catalogueId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the canonical unit processor lookup service for the given catalogue.
      Parameters:
      catalogueId - the Id of the Catalogue
      Returns:
      a CanonicalUnitProcessorLookupSession
      Throws:
      NotFoundException - no Catalogue found by the given Id
      NullArgumentException - catalogueId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCanonicalUnitProcessorLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCanonicalUnitProcessorLookup()} and {@code supportsVisibleFederation()} are {@code true} .

    • getCanonicalUnitProcessorQuerySession

      CanonicalUnitProcessorQuerySession getCanonicalUnitProcessorQuerySession() throws OperationFailedException
      Gets the OsidSession associated with the canonical unit processor query service.
      Returns:
      a CanonicalUnitProcessorQuerySession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCanonicalUnitProcessorQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCanonicalUnitProcessorQuery()} is {@code true} .

    • getCanonicalUnitProcessorQuerySessionForCatalogue

      CanonicalUnitProcessorQuerySession getCanonicalUnitProcessorQuerySessionForCatalogue(Id catalogueId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the canonical unit processor query service for the given catalogue.
      Parameters:
      catalogueId - the Id of the Catalogue
      Returns:
      a CanonicalUnitProcessorQuerySession
      Throws:
      NotFoundException - no Catalogue found by the given Id
      NullArgumentException - catalogueId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCanonicalUnitProcessorQuery() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCanonicalUnitProcessorQuery()} and {@code supportsVisibleFederation()} are {@code true} .

    • getCanonicalUnitProcessorSearchSession

      CanonicalUnitProcessorSearchSession getCanonicalUnitProcessorSearchSession() throws OperationFailedException
      Gets the OsidSession associated with the canonical unit processor search service.
      Returns:
      a CanonicalUnitProcessorSearchSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCanonicalUnitProcessorSearch() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCanonicalUnitProcessorSearch()} is {@code true} .

    • getCanonicalUnitProcessorSearchSessionForCatalogue

      CanonicalUnitProcessorSearchSession getCanonicalUnitProcessorSearchSessionForCatalogue(Id catalogueId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the canonical unit processor earch service for the given catalogue.
      Parameters:
      catalogueId - the Id of the Catalogue
      Returns:
      a CanonicalUnitProcessorSearchSession
      Throws:
      NotFoundException - no Catalogue found by the given Id
      NullArgumentException - catalogueId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCanonicalUnitProcessorSearch() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCanonicalUnitProcessorSearch()} and {@code supportsVisibleFederation()} are {@code true} .

    • getCanonicalUnitProcessorAdminSession

      CanonicalUnitProcessorAdminSession getCanonicalUnitProcessorAdminSession() throws OperationFailedException
      Gets the OsidSession associated with the canonical unit processor administration service.
      Returns:
      a CanonicalUnitProcessorAdminSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCanonicalUnitProcessorAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCanonicalUnitProcessorAdmin()} is {@code true} .

    • getCanonicalUnitProcessorAdminSessionForCatalogue

      CanonicalUnitProcessorAdminSession getCanonicalUnitProcessorAdminSessionForCatalogue(Id catalogueId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the canonical unit processor administration service for the given catalogue.
      Parameters:
      catalogueId - the Id of the Catalogue
      Returns:
      a CanonicalUnitProcessorAdminSession
      Throws:
      NotFoundException - no Catalogue found by the given Id
      NullArgumentException - catalogueId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCanonicalUnitProcessorAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCanonicalUnitProcessorAdmin()} and {@code supportsVisibleFederation()} are {@code true} .

    • getCanonicalUnitProcessorNotificationSession

      CanonicalUnitProcessorNotificationSession getCanonicalUnitProcessorNotificationSession(CanonicalUnitProcessorReceiver canonicalUnitProcessorReceiver) throws OperationFailedException
      Gets the OsidSession associated with the canonical unit processor notification service.
      Parameters:
      canonicalUnitProcessorReceiver - the notification callback
      Returns:
      a CanonicalUnitProcessorNotificationSession
      Throws:
      NullArgumentException - canonicalUnitProcessorReceiver is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCanonicalUnitProcessorNotification() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCanonicalUnitProcessorNotification()} is {@code true} .

    • getCanonicalUnitProcessorNotificationSessionForCatalogue

      CanonicalUnitProcessorNotificationSession getCanonicalUnitProcessorNotificationSessionForCatalogue(CanonicalUnitProcessorReceiver canonicalUnitProcessorReceiver, Id catalogueId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the canonical unit processor notification service for the given catalogue.
      Parameters:
      canonicalUnitProcessorReceiver - the notification callback
      catalogueId - the Id of the Catalogue
      Returns:
      a CanonicalUnitProcessorNotificationSession
      Throws:
      NotFoundException - no catalogue found by the given Id
      NullArgumentException - canonicalUnitProcessorReceiver or catalogueId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCanonicalUnitProcessorNotification() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCanonicalUnitProcessorNotification()} and {@code supportsVisibleFederation()} are {@code true} .

    • getCanonicalUnitProcessorCatalogueSession

      CanonicalUnitProcessorCatalogueSession getCanonicalUnitProcessorCatalogueSession() throws OperationFailedException
      Gets the OsidSession to lookup canonical unit processor/catalogue mappings for canonical unit processors.
      Returns:
      a CanonicalUnitProcessorCatalogueSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCanonicalUnitProcessorCatalogue() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCanonicalUnitProcessorCatalogue()} is {@code true} .

    • getCanonicalUnitProcessorCatalogueAssignmentSession

      CanonicalUnitProcessorCatalogueAssignmentSession getCanonicalUnitProcessorCatalogueAssignmentSession() throws OperationFailedException
      Gets the OsidSession associated with assigning canonical unit processor to catalogues.
      Returns:
      a CanonicalUnitProcessorCatalogueAssignmentSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCanonicalUnitProcessorCatalogueAssignment() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCanonicalUnitProcessorCatalogueAssignment()} is {@code true} .

    • getCanonicalUnitProcessorSmartCatalogueSession

      CanonicalUnitProcessorSmartCatalogueSession getCanonicalUnitProcessorSmartCatalogueSession(Id catalogueId) throws NotFoundException, OperationFailedException
      Gets the OsidSession to manage canonical unit processor smart catalogues.
      Parameters:
      catalogueId - the Id of the Catalogue
      Returns:
      a CanonicalUnitProcessorSmartCatalogueSession
      Throws:
      NotFoundException - no Catalogue found by the given Id
      NullArgumentException - catalogueId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCanonicalUnitProcessorSmartCatalogue() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCanonicalUnitProcessorSmartCatalogue()} is {@code true} .

    • getCanonicalUnitProcessorRuleLookupSession

      CanonicalUnitProcessorRuleLookupSession getCanonicalUnitProcessorRuleLookupSession() throws OperationFailedException
      Gets the OsidSession associated with the canonical unit processor canonical unit mapping lookup service for looking up the rules applied to the catalogue.
      Returns:
      a CanonicalUnitProcessorRuleLookupSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCanonicalUnitProcessorRuleLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCanonicalUnitProcessorRuleLookup()} is {@code true} .

    • getCanonicalUnitProcessorRuleLookupSessionForCatalogue

      CanonicalUnitProcessorRuleLookupSession getCanonicalUnitProcessorRuleLookupSessionForCatalogue(Id catalogueId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the canonical unit processor mapping lookup service for the given catalogue for looking up rules applied to a catalogue.
      Parameters:
      catalogueId - the Id of the Catalogue
      Returns:
      a CanonicalUnitProcessorRuleLookupSession
      Throws:
      NotFoundException - no Catalogue found by the given Id
      NullArgumentException - catalogueId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCanonicalUnitProcessorRuleLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCanonicalUnitProcessorRuleLookup()} and {@code supportsVisibleFederation()} are {@code true} .

    • getCanonicalUnitProcessorRuleApplicationSession

      CanonicalUnitProcessorRuleApplicationSession getCanonicalUnitProcessorRuleApplicationSession() throws OperationFailedException
      Gets the OsidSession associated with the canonical unit processor assignment service.
      Returns:
      a CanonicalUnitProcessorRuleApplicationSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCanonicalUnitProcessorRuleApplication() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCanonicalUnitProcessorRuleApplication()} is {@code true} .

    • getCanonicalUnitProcessorRuleApplicationSessionForCatalogue

      CanonicalUnitProcessorRuleApplicationSession getCanonicalUnitProcessorRuleApplicationSessionForCatalogue(Id catalogueId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the canonical unit processor assignment service for the given catalogue to apply to catalogues.
      Parameters:
      catalogueId - the Id of the Catalogue
      Returns:
      a CanonicalUnitProcessorRuleApplicationSession
      Throws:
      NotFoundException - no Catalogue found by the given Id
      NullArgumentException - catalogueId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCanonicalUnitProcessorRuleApplication() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCanonicalUnitProcessorRuleApplication()} and {@code supportsVisibleFederation()} are {@code true} .

    • getCanonicalUnitProcessorEnablerLookupSession

      CanonicalUnitProcessorEnablerLookupSession getCanonicalUnitProcessorEnablerLookupSession() throws OperationFailedException
      Gets the OsidSession associated with the canonical unit processor enabler lookup service.
      Returns:
      a CanonicalUnitProcessorEnablerLookupSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCanonicalUnitProcessorEnablerLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCanonicalUnitProcessorEnablerLookup()} is {@code true} .

    • getCanonicalUnitProcessorEnablerLookupSessionForCatalogue

      CanonicalUnitProcessorEnablerLookupSession getCanonicalUnitProcessorEnablerLookupSessionForCatalogue(Id catalogueId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the canonical unit processor enabler lookup service for the given catalogue.
      Parameters:
      catalogueId - the Id of the Catalogue
      Returns:
      a CanonicalUnitProcessorEnablerLookupSession
      Throws:
      NotFoundException - no Catalogue found by the given Id
      NullArgumentException - catalogueId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCanonicalUnitProcessorEnablerLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCanonicalUnitProcessorEnablerLookup()} and {@code supportsVisibleFederation()} are {@code true} .

    • getCanonicalUnitProcessorEnablerQuerySession

      CanonicalUnitProcessorEnablerQuerySession getCanonicalUnitProcessorEnablerQuerySession() throws OperationFailedException
      Gets the OsidSession associated with the canonical unit processor enabler query service.
      Returns:
      a CanonicalUnitProcessorEnablerQuerySession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCanonicalUnitProcessorEnablerQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCanonicalUnitProcessorEnablerQuery()} is {@code true} .

    • getCanonicalUnitProcessorEnablerQuerySessionForCatalogue

      CanonicalUnitProcessorEnablerQuerySession getCanonicalUnitProcessorEnablerQuerySessionForCatalogue(Id catalogueId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the canonical unit processor enabler query service for the given catalogue.
      Parameters:
      catalogueId - the Id of the Catalogue
      Returns:
      a CanonicalUnitProcessorEnablerQuerySession
      Throws:
      NotFoundException - no Catalogue found by the given Id
      NullArgumentException - catalogueId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCanonicalUnitProcessorEnablerQuery() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCanonicalUnitProcessorEnablerQuery()} and {@code supportsVisibleFederation()} are {@code true} .

    • getCanonicalUnitProcessorEnablerSearchSession

      CanonicalUnitProcessorEnablerSearchSession getCanonicalUnitProcessorEnablerSearchSession() throws OperationFailedException
      Gets the OsidSession associated with the canonical unit processor enabler search service.
      Returns:
      a CanonicalUnitProcessorEnablerSearchSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCanonicalUnitProcessorEnablerSearch() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCanonicalUnitProcessorEnablerSearch()} is {@code true} .

    • getCanonicalUnitProcessorEnablerSearchSessionForCatalogue

      CanonicalUnitProcessorEnablerSearchSession getCanonicalUnitProcessorEnablerSearchSessionForCatalogue(Id catalogueId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the canonical unit processor enablers earch service for the given catalogue.
      Parameters:
      catalogueId - the Id of the Catalogue
      Returns:
      a CanonicalUnitProcessorEnablerSearchSession
      Throws:
      NotFoundException - no Catalogue found by the given Id
      NullArgumentException - catalogueId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCanonicalUnitProcessorEnablerSearch() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCanonicalUnitProcessorEnablerSearch()} and {@code supportsVisibleFederation()} are {@code true} .

    • getCanonicalUnitProcessorEnablerAdminSession

      CanonicalUnitProcessorEnablerAdminSession getCanonicalUnitProcessorEnablerAdminSession() throws OperationFailedException
      Gets the OsidSession associated with the canonical unit processor enabler administration service.
      Returns:
      a CanonicalUnitProcessorEnablerAdminSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCanonicalUnitProcessorEnablerAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCanonicalUnitProcessorEnablerAdmin()} is {@code true} .

    • getCanonicalUnitProcessorEnablerAdminSessionForCatalogue

      CanonicalUnitProcessorEnablerAdminSession getCanonicalUnitProcessorEnablerAdminSessionForCatalogue(Id catalogueId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the canonical unit processor enabler administration service for the given catalogue.
      Parameters:
      catalogueId - the Id of the Catalogue
      Returns:
      a CanonicalUnitProcessorEnablerAdminSession
      Throws:
      NotFoundException - no Catalogue found by the given Id
      NullArgumentException - catalogueId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCanonicalUnitProcessorEnablerAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCanonicalUnitProcessorEnablerAdmin()} and {@code supportsVisibleFederation()} are {@code true} .

    • getCanonicalUnitProcessorEnablerNotificationSession

      CanonicalUnitProcessorEnablerNotificationSession getCanonicalUnitProcessorEnablerNotificationSession(CanonicalUnitProcessorEnablerReceiver canonicalUnitProcessorEnablerReceiver) throws OperationFailedException
      Gets the OsidSession associated with the canonical unit processor enabler notification service.
      Parameters:
      canonicalUnitProcessorEnablerReceiver - the notification callback
      Returns:
      a CanonicalUnitProcessorEnablerNotificationSession
      Throws:
      NullArgumentException - canonicalUnitProcessorEnablerReceiver is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCanonicalUnitProcessorEnablerNotification() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCanonicalUnitProcessorEnablerNotification()} is {@code true} .

    • getCanonicalUnitProcessorEnablerNotificationSessionForCatalogue

      CanonicalUnitProcessorEnablerNotificationSession getCanonicalUnitProcessorEnablerNotificationSessionForCatalogue(CanonicalUnitProcessorEnablerReceiver canonicalUnitProcessorEnablerReceiver, Id catalogueId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the canonical unit processor enabler notification service for the given catalogue.
      Parameters:
      canonicalUnitProcessorEnablerReceiver - the notification callback
      catalogueId - the Id of the Catalogue
      Returns:
      a CanonicalUnitProcessorEnablerNotificationSession
      Throws:
      NotFoundException - no catalogue found by the given Id
      NullArgumentException - canonicalUnitProcessorEnablerReceiver or catalogueId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCanonicalUnitProcessorEnablerNotification() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCanonicalUnitProcessorEnablerNotification()} and {@code supportsVisibleFederation()} are {@code true} .

    • getCanonicalUnitProcessorEnablerCatalogueSession

      CanonicalUnitProcessorEnablerCatalogueSession getCanonicalUnitProcessorEnablerCatalogueSession() throws OperationFailedException
      Gets the OsidSession to lookup canonical unit processor enabler/catalogue mappings for canonical unit processor enablers.
      Returns:
      a CanonicalUnitProcessorEnablerCatalogueSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCanonicalUnitProcessorEnablerCatalogue() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCanonicalUnitProcessorEnablerCatalogue()} is {@code true} .

    • getCanonicalUnitProcessorEnablerCatalogueAssignmentSession

      CanonicalUnitProcessorEnablerCatalogueAssignmentSession getCanonicalUnitProcessorEnablerCatalogueAssignmentSession() throws OperationFailedException
      Gets the OsidSession associated with assigning canonical unit processor enablers to catalogues.
      Returns:
      a CanonicalUnitProcessorEnablerCatalogueAssignmentSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCanonicalUnitProcessorEnablerCatalogueAssignment() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCanonicalUnitProcessorEnablerCatalogueAssignment()} is {@code true} .

    • getCanonicalUnitProcessorEnablerSmartCatalogueSession

      CanonicalUnitProcessorEnablerSmartCatalogueSession getCanonicalUnitProcessorEnablerSmartCatalogueSession(Id catalogueId) throws NotFoundException, OperationFailedException
      Gets the OsidSession to manage canonical unit processor enabler smart catalogues.
      Parameters:
      catalogueId - the Id of the Catalogue
      Returns:
      a CanonicalUnitProcessorEnablerSmartCatalogueSession
      Throws:
      NotFoundException - no Catalogue found by the given Id
      NullArgumentException - catalogueId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCanonicalUnitProcessorEnablerSmartCatalogue() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCanonicalUnitProcessorEnablerSmartCatalogue()} is {@code true} .

    • getCanonicalUnitProcessorEnablerRuleLookupSession

      CanonicalUnitProcessorEnablerRuleLookupSession getCanonicalUnitProcessorEnablerRuleLookupSession() throws OperationFailedException
      Gets the OsidSession associated with the canonical unit processor enabler mapping lookup service.
      Returns:
      a CanonicalUnitProcessorEnablerRuleLookupSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCanonicalUnitProcessorEnablerRuleLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCanonicalUnitProcessorEnablerRuleLookup()} is {@code true} .

    • getCanonicalUnitProcessorEnablerRuleLookupSessionForCatalogue

      CanonicalUnitProcessorEnablerRuleLookupSession getCanonicalUnitProcessorEnablerRuleLookupSessionForCatalogue(Id catalogueId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the canonical unit processor enabler mapping lookup service.
      Parameters:
      catalogueId - the Id of the Catalogue
      Returns:
      a CanonicalUnitProcessorEnablerRuleLookupSession
      Throws:
      NotFoundException - no Catalogue found by the given Id
      NullArgumentException - catalogueId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCanonicalUnitProcessorEnablerRuleLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCanonicalUnitProcessorEnablerRuleLookup()} and {@code supportsVisibleFederation()} are {@code true} .

    • getCanonicalUnitProcessorEnablerRuleApplicationSession

      CanonicalUnitProcessorEnablerRuleApplicationSession getCanonicalUnitProcessorEnablerRuleApplicationSession() throws OperationFailedException
      Gets the OsidSession associated with the canonical unit processor enabler assignment service.
      Returns:
      a CanonicalUnitProcessorEnablerRuleApplicationSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCanonicalUnitProcessorEnablerRuleApplication() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCanonicalUnitProcessorEnablerRuleApplication()} is {@code true} .

    • getCanonicalUnitProcessorEnablerRuleApplicationSessionForCatalogue

      CanonicalUnitProcessorEnablerRuleApplicationSession getCanonicalUnitProcessorEnablerRuleApplicationSessionForCatalogue(Id catalogueId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the canonical unit processor enabler assignment service for the given catalogue.
      Parameters:
      catalogueId - the Id of the Catalogue
      Returns:
      z CanonicalUnitProcessorEnablerRuleApplicationSession
      Throws:
      NotFoundException - no Catalogue found by the given Id
      NullArgumentException - catalogueId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCanonicalUnitProcessorEnablerRuleApplication() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCanonicalUnitProcessorEnablerRuleApplication()} and {@code supportsVisibleFederation()} are {@code true} .

    • getOfferingConstrainerLookupSession

      OfferingConstrainerLookupSession getOfferingConstrainerLookupSession() throws OperationFailedException
      Gets the OsidSession associated with the offering constrainer lookup service.
      Returns:
      an OfferingConstrainerLookupSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsOfferingConstrainerLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsOfferingConstrainerLookup()} is {@code true} .

    • getOfferingConstrainerLookupSessionForCatalogue

      OfferingConstrainerLookupSession getOfferingConstrainerLookupSessionForCatalogue(Id catalogueId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the offering constrainer lookup service for the given catalogue.
      Parameters:
      catalogueId - the Id of the Catalogue
      Returns:
      an OfferingConstrainerLookupSession
      Throws:
      NotFoundException - no Catalogue found by the given Id
      NullArgumentException - catalogueId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsOfferingConstrainerLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsOfferingConstrainerLookup()} and {@code supportsVisibleFederation()} are {@code true} .

    • getOfferingConstrainerQuerySession

      OfferingConstrainerQuerySession getOfferingConstrainerQuerySession() throws OperationFailedException
      Gets the OsidSession associated with the offering constrainer query service.
      Returns:
      an OfferingConstrainerQuerySession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsOfferingConstrainerQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsOfferingConstrainerQuery()} is {@code true} .

    • getOfferingConstrainerQuerySessionForCatalogue

      OfferingConstrainerQuerySession getOfferingConstrainerQuerySessionForCatalogue(Id catalogueId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the offering constrainer query service for the given catalogue.
      Parameters:
      catalogueId - the Id of the Catalogue
      Returns:
      an OfferingConstrainerQuerySession
      Throws:
      NotFoundException - no Catalogue found by the given Id
      NullArgumentException - catalogueId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsOfferingConstrainerQuery() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsOfferingConstrainerQuery()} and {@code supportsVisibleFederation()} are {@code true} .

    • getOfferingConstrainerSearchSession

      OfferingConstrainerSearchSession getOfferingConstrainerSearchSession() throws OperationFailedException
      Gets the OsidSession associated with the offering constrainer search service.
      Returns:
      an OfferingConstrainerSearchSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsOfferingConstrainerSearch() is false
      Compliance:
      optional - This method must be implemented if {@code supportsOfferingConstrainerSearch()} is {@code true} .

    • getOfferingConstrainerSearchSessionForCatalogue

      OfferingConstrainerSearchSession getOfferingConstrainerSearchSessionForCatalogue(Id catalogueId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the offering constrainer earch service for the given catalogue.
      Parameters:
      catalogueId - the Id of the Catalogue
      Returns:
      an OfferingConstrainerSearchSession
      Throws:
      NotFoundException - no Catalogue found by the given Id
      NullArgumentException - catalogueId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsOfferingConstrainerSearch() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsOfferingConstrainerSearch()} and {@code supportsVisibleFederation()} are {@code true} .

    • getOfferingConstrainerAdminSession

      OfferingConstrainerAdminSession getOfferingConstrainerAdminSession() throws OperationFailedException
      Gets the OsidSession associated with the offering constrainer administration service.
      Returns:
      an OfferingConstrainerAdminSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsOfferingConstrainerAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsOfferingConstrainerAdmin()} is {@code true} .

    • getOfferingConstrainerAdminSessionForCatalogue

      OfferingConstrainerAdminSession getOfferingConstrainerAdminSessionForCatalogue(Id catalogueId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the offering constrainer administration service for the given catalogue.
      Parameters:
      catalogueId - the Id of the Catalogue
      Returns:
      an OfferingConstrainerAdminSession
      Throws:
      NotFoundException - no Catalogue found by the given Id
      NullArgumentException - catalogueId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsOfferingConstrainerAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsOfferingConstrainerAdmin()} and {@code supportsVisibleFederation()} are {@code true} .

    • getOfferingConstrainerNotificationSession

      OfferingConstrainerNotificationSession getOfferingConstrainerNotificationSession(OfferingConstrainerReceiver offeringConstrainerReceiver) throws OperationFailedException
      Gets the OsidSession associated with the offering constrainer notification service.
      Parameters:
      offeringConstrainerReceiver - the notification callback
      Returns:
      an OfferingConstrainerNotificationSession
      Throws:
      NullArgumentException - offeringConstrainerReceiver is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsOfferingConstrainerNotification() is false
      Compliance:
      optional - This method must be implemented if {@code supportsOfferingConstrainerNotification()} is {@code true} .

    • getOfferingConstrainerNotificationSessionForCatalogue

      OfferingConstrainerNotificationSession getOfferingConstrainerNotificationSessionForCatalogue(OfferingConstrainerReceiver offeringConstrainerReceiver, Id catalogueId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the offering constrainer notification service for the given catalogue.
      Parameters:
      offeringConstrainerReceiver - the notification callback
      catalogueId - the Id of the Catalogue
      Returns:
      an OfferingConstrainerNotificationSession
      Throws:
      NotFoundException - no catalogue found by the given Id
      NullArgumentException - offeringConstrainerReceiver or catalogueId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsOfferingConstrainerNotification() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsOfferingConstrainerNotification()} and {@code supportsVisibleFederation()} are {@code true} .

    • getOfferingConstrainerCatalogueSession

      OfferingConstrainerCatalogueSession getOfferingConstrainerCatalogueSession() throws OperationFailedException
      Gets the OsidSession to lookup offering constrainer/catalogue mappings for offering constrainers.
      Returns:
      an OfferingConstrainerCatalogueSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsOfferingConstrainerCatalogue() is false
      Compliance:
      optional - This method must be implemented if {@code supportsOfferingConstrainerCatalogue()} is {@code true} .

    • getOfferingConstrainerCatalogueAssignmentSession

      OfferingConstrainerCatalogueAssignmentSession getOfferingConstrainerCatalogueAssignmentSession() throws OperationFailedException
      Gets the OsidSession associated with assigning offering constrainer to catalogues.
      Returns:
      an OfferingConstrainerCatalogueAssignmentSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsOfferingConstrainerCatalogueAssignment() is false
      Compliance:
      optional - This method must be implemented if {@code supportsOfferingConstrainerCatalogueAssignment()} is {@code true} .

    • getOfferingConstrainerSmartCatalogueSession

      OfferingConstrainerSmartCatalogueSession getOfferingConstrainerSmartCatalogueSession(Id catalogueId) throws NotFoundException, OperationFailedException
      Gets the OsidSession to manage offering constrainer smart catalogues.
      Parameters:
      catalogueId - the Id of the Catalogue
      Returns:
      an OfferingConstrainerSmartCatalogueSession
      Throws:
      NotFoundException - no Catalogue found by the given Id
      NullArgumentException - catalogueId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsOfferingConstrainerSmartCatalogue() is false
      Compliance:
      optional - This method must be implemented if {@code supportsOfferingConstrainerSmartCatalogue()} is {@code true} .

    • getOfferingConstrainerRuleLookupSession

      OfferingConstrainerRuleLookupSession getOfferingConstrainerRuleLookupSession() throws OperationFailedException
      Gets the OsidSession associated with the offering constrainer canonical unit mapping lookup service for looking up the rules applied to the catalogue.
      Returns:
      an OfferingConstrainerRuleLookupSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsOfferingConstrainerRuleLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsOfferingConstrainerRuleLookup()} is {@code true} .

    • getOfferingConstrainerRuleLookupSessionForCatalogue

      OfferingConstrainerRuleLookupSession getOfferingConstrainerRuleLookupSessionForCatalogue(Id catalogueId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the offering constrainer mapping lookup service for the given catalogue for looking up rules applied to a catalogue.
      Parameters:
      catalogueId - the Id of the Catalogue
      Returns:
      an OfferingConstrainerRuleLookupSession
      Throws:
      NotFoundException - no Catalogue found by the given Id
      NullArgumentException - catalogueId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsOfferingConstrainerRuleLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsOfferingConstrainerRuleLookup()} and {@code supportsVisibleFederation()} are {@code true} .

    • getOfferingConstrainerRuleApplicationSession

      OfferingConstrainerRuleApplicationSession getOfferingConstrainerRuleApplicationSession() throws OperationFailedException
      Gets the OsidSession associated with the offering constrainer assignment service to apply to catalogues.
      Returns:
      an OfferingConstrainerRuleApplicationSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsOfferingConstrainerRuleApplication() is false
      Compliance:
      optional - This method must be implemented if {@code supportsOfferingConstrainerRuleApplication()} is {@code true} .

    • getOfferingConstrainerRuleApplicationSessionForCatalogue

      OfferingConstrainerRuleApplicationSession getOfferingConstrainerRuleApplicationSessionForCatalogue(Id catalogueId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the offering constrainer assignment service for the given catalogue to apply to catalogues.
      Parameters:
      catalogueId - the Id of the Catalogue
      Returns:
      an OfferingConstrainerRuleApplicationSession
      Throws:
      NotFoundException - no Catalogue found by the given Id
      NullArgumentException - catalogueId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsOfferingConstrainerRuleApplication() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsOfferingConstrainerRuleApplication()} and {@code supportsVisibleFederation()} are {@code true} .

    • getOfferingConstrainerEnablerLookupSession

      OfferingConstrainerEnablerLookupSession getOfferingConstrainerEnablerLookupSession() throws OperationFailedException
      Gets the OsidSession associated with the offering constrainer enabler lookup service.
      Returns:
      an OfferingConstrainerEnablerLookupSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsOfferingConstrainerEnablerLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsOfferingConstrainerEnablerLookup()} is {@code true} .

    • getOfferingConstrainerEnablerLookupSessionForCatalogue

      OfferingConstrainerEnablerLookupSession getOfferingConstrainerEnablerLookupSessionForCatalogue(Id catalogueId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the offering constrainer enabler lookup service for the given catalogue.
      Parameters:
      catalogueId - the Id of the Catalogue
      Returns:
      an OfferingConstrainerEnablerLookupSession
      Throws:
      NotFoundException - no Catalogue found by the given Id
      NullArgumentException - catalogueId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsOfferingConstrainerEnablerLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsOfferingConstrainerEnablerLookup()} and {@code supportsVisibleFederation()} are {@code true} .

    • getOfferingConstrainerEnablerQuerySession

      OfferingConstrainerEnablerQuerySession getOfferingConstrainerEnablerQuerySession() throws OperationFailedException
      Gets the OsidSession associated with the offering constrainer enabler query service.
      Returns:
      an OfferingConstrainerEnablerQuerySession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsOfferingConstrainerEnablerQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsOfferingConstrainerEnablerQuery()} is {@code true} .

    • getOfferingConstrainerEnablerQuerySessionForCatalogue

      OfferingConstrainerEnablerQuerySession getOfferingConstrainerEnablerQuerySessionForCatalogue(Id catalogueId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the offering constrainer enabler query service for the given catalogue.
      Parameters:
      catalogueId - the Id of the Catalogue
      Returns:
      an OfferingConstrainerEnablerQuerySession
      Throws:
      NotFoundException - no Catalogue found by the given Id
      NullArgumentException - catalogueId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsOfferingConstrainerEnablerQuery() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsOfferingConstrainerEnablerQuery()} and {@code supportsVisibleFederation()} are {@code true} .

    • getOfferingConstrainerEnablerSearchSession

      OfferingConstrainerEnablerSearchSession getOfferingConstrainerEnablerSearchSession() throws OperationFailedException
      Gets the OsidSession associated with the offering constrainer enabler search service.
      Returns:
      an OfferingConstrainerEnablerSearchSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsOfferingConstrainerEnablerSearch() is false
      Compliance:
      optional - This method must be implemented if {@code supportsOfferingConstrainerEnablerSearch()} is {@code true} .

    • getOfferingConstrainerEnablerSearchSessionForCatalogue

      OfferingConstrainerEnablerSearchSession getOfferingConstrainerEnablerSearchSessionForCatalogue(Id catalogueId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the offering constrainer enablers earch service for the given catalogue.
      Parameters:
      catalogueId - the Id of the Catalogue
      Returns:
      an OfferingConstrainerEnablerSearchSession
      Throws:
      NotFoundException - no Catalogue found by the given Id
      NullArgumentException - catalogueId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsOfferingConstrainerEnablerSearch() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsOfferingConstrainerEnablerSearch()} and {@code supportsVisibleFederation()} are {@code true} .

    • getOfferingConstrainerEnablerAdminSession

      OfferingConstrainerEnablerAdminSession getOfferingConstrainerEnablerAdminSession() throws OperationFailedException
      Gets the OsidSession associated with the offering constrainer enabler administration service.
      Returns:
      an OfferingConstrainerEnablerAdminSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsOfferingConstrainerEnablerAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsOfferingConstrainerEnablerAdmin()} is {@code true} .

    • getOfferingConstrainerEnablerAdminSessionForCatalogue

      OfferingConstrainerEnablerAdminSession getOfferingConstrainerEnablerAdminSessionForCatalogue(Id catalogueId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the offering constrainer enabler administration service for the given catalogue.
      Parameters:
      catalogueId - the Id of the Catalogue
      Returns:
      an OfferingConstrainerEnablerAdminSession
      Throws:
      NotFoundException - no Catalogue found by the given Id
      NullArgumentException - catalogueId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsOfferingConstrainerEnablerAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsOfferingConstrainerEnablerAdmin()} and {@code supportsVisibleFederation()} are {@code true} .

    • getOfferingConstrainerEnablerNotificationSession

      OfferingConstrainerEnablerNotificationSession getOfferingConstrainerEnablerNotificationSession(OfferingConstrainerEnablerReceiver offeringConstrainerEnablerReceiver) throws OperationFailedException
      Gets the OsidSession associated with the offering constrainer enabler notification service.
      Parameters:
      offeringConstrainerEnablerReceiver - the notification callback
      Returns:
      an OfferingConstrainerEnablerNotificationSession
      Throws:
      NullArgumentException - offeringConstrainerEnablerReceiver is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsOfferingConstrainerEnablerNotification() is false
      Compliance:
      optional - This method must be implemented if {@code supportsOfferingConstrainerEnablerNotification()} is {@code true} .

    • getOfferingConstrainerEnablerNotificationSessionForCatalogue

      OfferingConstrainerEnablerNotificationSession getOfferingConstrainerEnablerNotificationSessionForCatalogue(OfferingConstrainerEnablerReceiver offeringConstrainerEnablerReceiver, Id catalogueId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the offering constrainer enabler notification service for the given catalogue.
      Parameters:
      offeringConstrainerEnablerReceiver - the notification callback
      catalogueId - the Id of the Catalogue
      Returns:
      an OfferingConstrainerEnablerNotificationSession
      Throws:
      NotFoundException - no catalogue found by the given Id
      NullArgumentException - offeringConstrainerEnablerReceiver or catalogueId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsOfferingConstrainerEnablerNotification() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsOfferingConstrainerEnablerNotification()} and {@code supportsVisibleFederation()} are {@code true} .

    • getOfferingConstrainerEnablerCatalogueSession

      OfferingConstrainerEnablerCatalogueSession getOfferingConstrainerEnablerCatalogueSession() throws OperationFailedException
      Gets the OsidSession to lookup offering constrainer enabler/catalogue mappings for offering constrainer enablers.
      Returns:
      an OfferingConstrainerEnablerCatalogueSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsOfferingConstrainerEnablerCatalogue() is false
      Compliance:
      optional - This method must be implemented if {@code supportsOfferingConstrainerEnablerCatalogue()} is {@code true} .

    • getOfferingConstrainerEnablerCatalogueAssignmentSession

      OfferingConstrainerEnablerCatalogueAssignmentSession getOfferingConstrainerEnablerCatalogueAssignmentSession() throws OperationFailedException
      Gets the OsidSession associated with assigning offering constrainer enablers to catalogues.
      Returns:
      an OfferingConstrainerEnablerCatalogueAssignmentSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsOfferingConstrainerEnablerCatalogueAssignment() is false
      Compliance:
      optional - This method must be implemented if {@code supportsOfferingConstrainerEnablerCatalogueAssignment()} is {@code true} .

    • getOfferingConstrainerEnablerSmartCatalogueSession

      OfferingConstrainerEnablerSmartCatalogueSession getOfferingConstrainerEnablerSmartCatalogueSession(Id catalogueId) throws NotFoundException, OperationFailedException
      Gets the OsidSession to manage offering constrainer enabler smart catalogues.
      Parameters:
      catalogueId - the Id of the Catalogue
      Returns:
      an OfferingConstrainerEnablerSmartCatalogueSession
      Throws:
      NotFoundException - no Catalogue found by the given Id
      NullArgumentException - catalogueId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsOfferingConstrainerEnablerSmartCatalogue() is false
      Compliance:
      optional - This method must be implemented if {@code supportsOfferingConstrainerEnablerSmartCatalogue()} is {@code true} .

    • getOfferingConstrainerEnablerRuleLookupSession

      OfferingConstrainerEnablerRuleLookupSession getOfferingConstrainerEnablerRuleLookupSession() throws OperationFailedException
      Gets the OsidSession associated with the offering constrainer enabler mapping lookup service.
      Returns:
      an OfferingConstrainerEnablerRuleLookupSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsOfferingConstrainerEnablerRuleLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsOfferingConstrainerEnablerRuleLookup()} is {@code true} .

    • getOfferingConstrainerEnablerRuleLookupSessionForCatalogue

      OfferingConstrainerEnablerRuleLookupSession getOfferingConstrainerEnablerRuleLookupSessionForCatalogue(Id catalogueId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the offering constrainer enabler mapping lookup service for the given catalogue.
      Parameters:
      catalogueId - the Id of the Catalogue
      Returns:
      an OfferingConstrainerEnablerRuleLookupSession
      Throws:
      NotFoundException - no Catalogue found by the given Id
      NullArgumentException - catalogueId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsOfferingConstrainerEnablerRuleLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsOfferingConstrainerEnablerRuleLookup()} and {@code supportsVisibleFederation()} are {@code true} .

    • getOfferingConstrainerEnablerRuleApplicationSession

      OfferingConstrainerEnablerRuleApplicationSession getOfferingConstrainerEnablerRuleApplicationSession() throws OperationFailedException
      Gets the OsidSession associated with the offering constrainer enabler assignment service.
      Returns:
      an OfferingConstrainerEnablerRuleApplicationSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsOfferingConstrainerEnablerRuleApplication() is false
      Compliance:
      optional - This method must be implemented if {@code supportsOfferingConstrainerEnablerRuleApplication()} is {@code true} .

    • getOfferingConstrainerEnablerRuleApplicationSessionForCatalogue

      OfferingConstrainerEnablerRuleApplicationSession getOfferingConstrainerEnablerRuleApplicationSessionForCatalogue(Id catalogueId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the offering constrainer enabler assignment service for the given catalogue.
      Parameters:
      catalogueId - the Id of the Catalogue
      Returns:
      an OfferingConstrainerEnablerRuleApplicationSession
      Throws:
      NotFoundException - no Catalogue found by the given Id
      NullArgumentException - catalogueId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsOfferingConstrainerEnablerRuleApplication() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsOfferingConstrainerEnablerRuleApplication()} and {@code supportsVisibleFederation()} are {@code true} .