Interface CatalogingRulesManager

All Superinterfaces:
AutoCloseable, CatalogingRulesProfile, Closeable, OsidManager, OsidManager, OsidProfile, Sourceable
public interface CatalogingRulesManager extends OsidManager, CatalogingRulesProfile

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

  • CatalogEnablerLookupSession : a session to retrieve catalog enablers
  • CatalogEnablerQuerySession : a session to query for catalog enablers
  • CatalogEnablerSearchSession : a session to search for catalog enablers
  • CatalogEnablerAdminSession : a session to create and delete catalog enablers
  • CatalogEnablerNotificationSession : a session to receive notifications pertaining to catalog enabler changes
  • CatalogEnablerCatalogSession : a session to look up catalog enabler catalog mappings
  • CatalogEnablerCatalogAssignmentSession : a session to manage catalog enabler to catalog mappings
  • CatalogEnablerSmartCatalogSession : a session to manage dynamic catalogs of catalog enablers
  • CatalogEnableRuleLookupSession : a session to look up catalog enabler to catalog mappings
  • CatalogEnablerRuleApplicationSession : a session to apply catalog enablers to catalogs

  • Method Details

    • getCatalogEnablerLookupSession

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

    • getCatalogEnablerLookupSessionForCatalog

      CatalogEnablerLookupSession getCatalogEnablerLookupSessionForCatalog(Id catalogId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the catalog enabler lookup service for the given catalog.
      Parameters:
      catalogId - the Id of the Catalog
      Returns:
      a CatalogEnablerLookupSession
      Throws:
      NotFoundException - no Catalog found by the given Id
      NullArgumentException - catalogId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCatalogEnablerLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCatalogEnablerLookup()} and {@code supportsVisibleFederation()} are {@code true} .

    • getCatalogEnablerQuerySession

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

    • getCatalogEnablerQuerySessionForCatalog

      CatalogEnablerQuerySession getCatalogEnablerQuerySessionForCatalog(Id catalogId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the catalog enabler query service for the given catalog.
      Parameters:
      catalogId - the Id of the Catalog
      Returns:
      a CatalogEnablerQuerySession
      Throws:
      NotFoundException - no Catalog found by the given Id
      NullArgumentException - catalogId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCatalogEnablerQuery() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCatalogEnablerQuery()} and {@code supportsVisibleFederation()} are {@code true} .

    • getCatalogEnablerSearchSession

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

    • getCatalogEnablerSearchSessionForCatalog

      CatalogEnablerSearchSession getCatalogEnablerSearchSessionForCatalog(Id catalogId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the catalog enablers earch service for the given catalog.
      Parameters:
      catalogId - the Id of the Catalog
      Returns:
      a CatalogEnablerSearchSession
      Throws:
      NotFoundException - no Catalog found by the given Id
      NullArgumentException - catalogId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCatalogEnablerSearch() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCatalogEnablerSearch()} and {@code supportsVisibleFederation()} are {@code true} .

    • getCatalogEnablerAdminSession

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

    • getCatalogEnablerAdminSessionForCatalog

      CatalogEnablerAdminSession getCatalogEnablerAdminSessionForCatalog(Id catalogId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the catalog enabler administration service for the given catalog.
      Parameters:
      catalogId - the Id of the Catalog
      Returns:
      a CatalogEnablerAdminSession
      Throws:
      NotFoundException - no Catalog found by the given Id
      NullArgumentException - catalogId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCatalogEnablerAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCatalogEnablerAdmin()} and {@code supportsVisibleFederation()} are {@code true} .

    • getCatalogEnablerNotificationSession

      CatalogEnablerNotificationSession getCatalogEnablerNotificationSession(CatalogEnablerReceiver catalogEnablerReceiver) throws OperationFailedException
      Gets the OsidSession associated with the catalog enabler notification service.
      Parameters:
      catalogEnablerReceiver - the notification callback
      Returns:
      a CatalogEnablerNotificationSession
      Throws:
      NullArgumentException - catalogEnablerReceiver is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCatalogEnablerNotification() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCatalogEnablerNotification()} is {@code true} .

    • getCatalogEnablerNotificationSessionForCatalog

      CatalogEnablerNotificationSession getCatalogEnablerNotificationSessionForCatalog(CatalogEnablerReceiver catalogEnablerReceiver, Id catalogId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the catalog enabler notification service for the given catalog.
      Parameters:
      catalogEnablerReceiver - the notification callback
      catalogId - the Id of the Catalog
      Returns:
      a CatalogEnablerNotificationSession
      Throws:
      NotFoundException - no catalog found by the given Id
      NullArgumentException - catalogEnablerReceiver or catalogId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCatalogEnablerNotification() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCatalogEnablerNotification()} and {@code supportsVisibleFederation()} are {@code true} .

    • getCatalogEnablerCatalogSession

      CatalogEnablerCatalogSession getCatalogEnablerCatalogSession() throws OperationFailedException
      Gets the OsidSession to lookup catalog enabler/catalog mappings for cataloging enablers.
      Returns:
      a CatalogEnablerCatalogSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCatalogEnablerCatalog() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCatalogEnablerCatalog()} is {@code true} .

    • getCatalogEnablerCatalogAssignmentSession

      CatalogEnablerCatalogAssignmentSession getCatalogEnablerCatalogAssignmentSession() throws OperationFailedException
      Gets the OsidSession associated with assigning catalog enablers to catalogs for cataloging.
      Returns:
      a CatalogEnablerCatalogAssignmentSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCatalogEnablerCatalogAssignment() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCatalogEnablerCatalogAssignment()} is {@code true} .

    • getCatalogEnablerSmartCatalogSession

      CatalogEnablerSmartCatalogSession getCatalogEnablerSmartCatalogSession(Id catalogId) throws NotFoundException, OperationFailedException
      Gets the OsidSession to manage catalog enabler smart catalogs.
      Parameters:
      catalogId - the Id of the Catalog
      Returns:
      a CatalogEnablerSmartCatalogSession
      Throws:
      NotFoundException - no Catalog found by the given Id
      NullArgumentException - catalogId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCatalogEnablerSmartCatalog() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCatalogEnablerSmartCatalog()} is {@code true} .

    • getCatalogEnablerRuleLookupSession

      CatalogEnablerRuleLookupSession getCatalogEnablerRuleLookupSession() throws OperationFailedException
      Gets the OsidSession associated with the catalog enabler mapping lookup service for looking up the rules applied to the catalog.
      Returns:
      a CatalogEnablerRuleLookupSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCatalogEnablerRuleLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCatalogEnablerRuleLookup()} is {@code true} .

    • getCatalogEnablerRuleLookupSessionForCatalog

      CatalogEnablerRuleLookupSession getCatalogEnablerRuleLookupSessionForCatalog(Id catalogId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the catalog enabler mapping lookup service for the given catalog for looking up rules applied to a catalog.
      Parameters:
      catalogId - the Id of the Catalog
      Returns:
      a CatalogEnablerRuleLookupSession
      Throws:
      NotFoundException - no Catalog found by the given Id
      NullArgumentException - catalogId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCatalogEnablerRuleLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCatalogEnablerRuleLookup()} and {@code supportsVisibleFederation()} are {@code true} .

    • getCatalogEnablerRuleApplicationSession

      CatalogEnablerRuleApplicationSession getCatalogEnablerRuleApplicationSession() throws OperationFailedException
      Gets the OsidSession associated with the catalog enabler assignment service to apply enablers to catalogs.
      Returns:
      a CatalogEnablerRuleApplicationSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCatalogEnablerRuleApplication() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCatalogEnablerRuleApplication()} is {@code true} .

    • getCatalogEnablerRuleApplicationSessionForCatalog

      CatalogEnablerRuleApplicationSession getCatalogEnablerRuleApplicationSessionForCatalog(Id catalogId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the catalog enabler assignment service for the given catalog to apply enablers to catalogs.
      Parameters:
      catalogId - the Id of the Catalog
      Returns:
      a CatalogEnablerRuleApplicationSession
      Throws:
      NotFoundException - no Catalog found by the given Id
      NullArgumentException - catalogId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCatalogEnablerRuleApplication() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCatalogEnablerRuleApplication()} and {@code supportsVisibleFederation()} are {@code true} .