org.osid.cataloging.rules

Interface CatalogingRulesManager

All Superinterfaces:

java.lang.AutoCloseable, CatalogingRulesProfile, java.io.Closeable, 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 Summary

Methods

Modifier and Type	Method and Description
CatalogEnablerAdminSession	getCatalogEnablerAdminSession() Gets the OsidSession associated with the catalog enabler administration service.
CatalogEnablerAdminSession	getCatalogEnablerAdminSessionForCatalog(Id catalogId) Gets the OsidSession associated with the catalog enabler administration service for the given catalog.
CatalogEnablerCatalogAssignmentSession	getCatalogEnablerCatalogAssignmentSession() Gets the OsidSession associated with assigning catalog enablers to catalogs for cataloging.
CatalogEnablerCatalogSession	getCatalogEnablerCatalogSession() Gets the OsidSession to lookup catalog enabler/catalog mappings for cataloging enablers.
CatalogEnablerLookupSession	getCatalogEnablerLookupSession() Gets the OsidSession associated with the catalog enabler lookup service.
CatalogEnablerLookupSession	getCatalogEnablerLookupSessionForCatalog(Id catalogId) Gets the OsidSession associated with the catalog enabler lookup service for the given catalog.
CatalogEnablerNotificationSession	getCatalogEnablerNotificationSession(CatalogEnablerReceiver catalogEnablerReceiver) Gets the OsidSession associated with the catalog enabler notification service.
CatalogEnablerNotificationSession	getCatalogEnablerNotificationSessionForCatalog(CatalogEnablerReceiver catalogEnablerReceiver, Id catalogId) Gets the OsidSession associated with the catalog enabler notification service for the given catalog.
CatalogEnablerQuerySession	getCatalogEnablerQuerySession() Gets the OsidSession associated with the catalog enabler query service.
CatalogEnablerQuerySession	getCatalogEnablerQuerySessionForCatalog(Id catalogId) Gets the OsidSession associated with the catalog enabler query service for the given catalog.
CatalogEnablerRuleApplicationSession	getCatalogEnablerRuleApplicationSession() Gets the OsidSession associated with the catalog enabler assignment service to apply enablers to catalogs.
CatalogEnablerRuleApplicationSession	getCatalogEnablerRuleApplicationSessionForCatalog(Id catalogId) Gets the OsidSession associated with the catalog enabler assignment service for the given catalog to apply enablers to catalogs.
CatalogEnablerRuleLookupSession	getCatalogEnablerRuleLookupSession() Gets the OsidSession associated with the catalog enabler mapping lookup service for looking up the rules applied to the catalog.
CatalogEnablerRuleLookupSession	getCatalogEnablerRuleLookupSessionForCatalog(Id catalogId) Gets the OsidSession associated with the catalog enabler mapping lookup service for the given catalog for looking up rules applied to a catalog.
CatalogEnablerSearchSession	getCatalogEnablerSearchSession() Gets the OsidSession associated with the catalog enabler search service.
CatalogEnablerSearchSession	getCatalogEnablerSearchSessionForCatalog(Id catalogId) Gets the OsidSession associated with the catalog enablers earch service for the given catalog.
CatalogEnablerSmartCatalogSession	getCatalogEnablerSmartCatalogSession(Id catalogId) Gets the OsidSession to manage catalog enabler smart catalogs.

Methods inherited from interface org.osid.OsidManager

changeBranch, initialize, rollbackService

Methods inherited from interface org.osid.binding.java.OsidManager

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.cataloging.rules.CatalogingRulesProfile

getCatalogEnablerRecordTypes, getCatalogEnablerSearchRecordTypes, supportsCatalogEnablerAdmin, supportsCatalogEnablerCatalog, supportsCatalogEnablerCatalogAssignment, supportsCatalogEnablerLookup, supportsCatalogEnablerNotification, supportsCatalogEnablerQuery, supportsCatalogEnablerRecordType, supportsCatalogEnablerRuleApplication, supportsCatalogEnablerRuleLookup, supportsCatalogEnablerSearch, supportsCatalogEnablerSearchRecordType, supportsCatalogEnablerSmartCatalog, supportsVisibleFederation

Methods inherited from interface org.osid.OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

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 supportsCatalogEnablerLookup() is 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 supportsCatalogEnablerLookup() and supportsVisibleFederation() are 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 supportsCatalogEnablerQuery() is 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 supportsCatalogEnablerQuery() and supportsVisibleFederation() are 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 supportsCatalogEnablerSearch() is 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 supportsCatalogEnablerSearch() and supportsVisibleFederation() are 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 supportsCatalogEnablerAdmin() is 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 supportsCatalogEnablerAdmin() and supportsVisibleFederation() are 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 supportsCatalogEnablerNotification() is 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 supportsCatalogEnablerNotification() and supportsVisibleFederation() are 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 supportsCatalogEnablerCatalog() is 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 supportsCatalogEnablerCatalogAssignment() is 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 supportsCatalogEnablerSmartCatalog() is 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 supportsCatalogEnablerRuleLookup() is 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 supportsCatalogEnablerRuleLookup() and supportsVisibleFederation() are 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 supportsCatalogEnablerRuleApplication() is 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 supportsCatalogEnablerRuleApplication() and supportsVisibleFederation() are true.