org.osid.cataloging

Interface CatalogingProxyManager

All Superinterfaces:

java.lang.AutoCloseable, CatalogingProfile, java.io.Closeable, OsidProfile, OsidProxyManager, Sourceable

public interface CatalogingProxyManager
extends OsidProxyManager, CatalogingProfile

The cataloging manager provides access to cataloging sessions and provides interoperability tests for various aspects of this service. Methods in this manager support the passing of a Proxy for the purposes of passing information from server environments.

• CatalogSession: a session to lookup mappings to catalogs
• CatalogAssignmentSession: a session to manage Id to Catalog mappings
• CatalogEntryNotificationSession: a session to receive notification of changed mappings
• CatalogLookupSession: a session to retrieve catalogs
• CatalogQuerySession: a session to query catalogs
• CatalogSearchSession: a session to search for catalogs
• CatalogAdminSession: a session to create, update and delete catalogs
• CatalogNotificationSession: a session to receive notifications for changes in catalogs
• CatalogHierarchyTraversalSession: a session to traverse hierarchies of catalogs
• CatalogHierarchyDesignSession: a session to manage hierarchues of catalogs

The cataloging manager also provides a profile for determing the supported search types supported by this service.

Method Summary

Methods

Modifier and Type	Method and Description
CatalogAdminSession	getCatalogAdminSession(Proxy proxy) Gets the catalog administrative session for creating, updating and deleting catalogs.
CatalogAssignmentSession	getCatalogAssignmentSession(Proxy proxy) Gets the catalog session for mapping Ids to Catalogs.
CatalogEntryNotificationSession	getCatalogEntryNotificationSession(CatalogEntryReceiver catalogEntryReceiver, Proxy proxy) Gets the catalog session for mapping Ids to Catalogs.
CatalogEntryNotificationSession	getCatalogEntryNotificationSessionForCatalog(CatalogEntryReceiver catalogEntryReceiver, Id catalogId, Proxy proxy) Gets the notification session for subscribing to changes to catalogs for the given catalog.
CatalogHierarchyDesignSession	getCatalogHierarchyDesignSession(Proxy proxy) Gets the catalog hierarchy design session.
CatalogHierarchySession	getCatalogHierarchySession(Proxy proxy) Gets the catalog hierarchy traversal session.
CatalogingRulesProxyManager	getCatalogingRulesProxyManager() Gets the cataloging rules proxy manager.
CatalogLookupSession	getCatalogLookupSession(Proxy proxy) Gets the catalog lookup session.
CatalogNotificationSession	getCatalogNotificationSession(CatalogReceiver catalogReceiver, Proxy proxy) Gets the notification session for subscribing to changes to catalogs.
CatalogQuerySession	getCatalogQuerySession(Proxy proxy) Gets the catalog query session.
CatalogSearchSession	getCatalogSearchSession(Proxy proxy) Gets the catalog search session.
CatalogSession	getCatalogSession(Proxy proxy) Gets the catalog session for retrieving Id to Catalog mappings.

Methods inherited from interface org.osid.OsidProxyManager

changeBranch, initialize, rollbackService

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

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.cataloging.CatalogingProfile

getCatalogRecordTypes, getCatalogSearchRecordTypes, supportsCatalog, supportsCatalogAdmin, supportsCatalogAssignment, supportsCatalogEntryNotification, supportsCatalogHierarchy, supportsCatalogHierarchyDesign, supportsCatalogingRules, supportsCatalogLookup, supportsCatalogNotification, supportsCatalogQuery, supportsCatalogRecordType, supportsCatalogSearch, supportsCatalogSearchRecordType, 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

getCatalogSession

CatalogSession getCatalogSession(Proxy proxy)
                                 throws OperationFailedException

Gets the catalog session for retrieving Id to Catalog mappings.

Parameters:

proxy - a proxy

Returns:

a CatalogSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCatalog() is false

Compliance:

optional - This method must be implemented if supportsCatalog() is true.

getCatalogAssignmentSession

CatalogAssignmentSession getCatalogAssignmentSession(Proxy proxy)
                                                     throws OperationFailedException

Gets the catalog session for mapping Ids to Catalogs.

Parameters:

proxy - a proxy

Returns:

a CatalogAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCatalogAssignment() is false

Compliance:

optional - This method must be implemented if supportsCatalogAssignment() is true.

getCatalogEntryNotificationSession

CatalogEntryNotificationSession getCatalogEntryNotificationSession(CatalogEntryReceiver catalogEntryReceiver,
                                                                 Proxy proxy)
                                                                   throws OperationFailedException

Gets the catalog session for mapping Ids to Catalogs.

Parameters:

catalogEntryReceiver - the notification callback

proxy - a proxy

Returns:

a CatalogEntryNotificationSession

Throws:

NullArgumentException - catalogEntryReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCatalogEntrytNotification() is false

Compliance:

optional - This method must be implemented if supportsCatalogEntryNotification() is true.

getCatalogEntryNotificationSessionForCatalog

CatalogEntryNotificationSession getCatalogEntryNotificationSessionForCatalog(CatalogEntryReceiver catalogEntryReceiver,
                                                                           Id catalogId,
                                                                           Proxy proxy)
                                                                             throws OperationFailedException

Gets the notification session for subscribing to changes to catalogs for the given catalog.

Parameters:

catalogEntryReceiver - the notification callback

catalogId - the Id of the Catalog

proxy - a proxy

Returns:

a CatalogEntryNotificationSession

Throws:

NullArgumentException - catalogEntryReceiver, catalogId, or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCatalogEntryNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsCatalogEntryNotification() and supportsVisibleFederation() are true

getCatalogLookupSession

CatalogLookupSession getCatalogLookupSession(Proxy proxy)
                                             throws OperationFailedException

Gets the catalog lookup session.

Parameters:

proxy - a proxy

Returns:

a CatalogLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCatalogLookup() is false

Compliance:

optional - This method must be implemented if supportsCatalogLookup() is true.

getCatalogQuerySession

CatalogQuerySession getCatalogQuerySession(Proxy proxy)
                                           throws OperationFailedException

Gets the catalog query session.

Parameters:

proxy - a proxy

Returns:

a CatalogQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCatalogQuery() is false

Compliance:

optional - This method must be implemented if supportsCatalogQuery() is true.

getCatalogSearchSession

CatalogSearchSession getCatalogSearchSession(Proxy proxy)
                                             throws OperationFailedException

Gets the catalog search session.

Parameters:

proxy - a proxy

Returns:

a CatalogSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCatalogSearch() is false

Compliance:

optional - This method must be implemented if supportsCatalogSearch() is true.

getCatalogAdminSession

CatalogAdminSession getCatalogAdminSession(Proxy proxy)
                                           throws OperationFailedException

Gets the catalog administrative session for creating, updating and deleting catalogs.

Parameters:

proxy - a proxy

Returns:

a CatalogAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCatalogAdmin() is false

Compliance:

optional - This method must be implemented if supportsCatalogAdmin() is true.

getCatalogNotificationSession

CatalogNotificationSession getCatalogNotificationSession(CatalogReceiver catalogReceiver,
                                                       Proxy proxy)
                                                         throws OperationFailedException

Gets the notification session for subscribing to changes to catalogs.

Parameters:

catalogReceiver - the notification callback

proxy - a proxy

Returns:

a CatalogNotificationSession

Throws:

NullArgumentException - catalogReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCatalogNotification() is false

Compliance:

optional - This method must be implemented if supportsCatalogNotification() is true.

getCatalogHierarchySession

CatalogHierarchySession getCatalogHierarchySession(Proxy proxy)
                                                   throws OperationFailedException

Gets the catalog hierarchy traversal session.

Parameters:

proxy - proxy

Returns:

a CatalogHierarchySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCatalogHierarchy() is false

Compliance:

optional - This method must be implemented if supportsCatalogHierarchy() is true.

getCatalogHierarchyDesignSession

CatalogHierarchyDesignSession getCatalogHierarchyDesignSession(Proxy proxy)
                                                               throws OperationFailedException

Gets the catalog hierarchy design session.

Parameters:

proxy - proxy

Returns:

a CatalogHierarchyDesignSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCatalogHierarchyDesign() is false

Compliance:

optional - This method must be implemented if supportsCatalogHierarchyDesign() is true.

getCatalogingRulesProxyManager

CatalogingRulesProxyManager getCatalogingRulesProxyManager()
                                                           throws OperationFailedException

Gets the cataloging rules proxy manager.

Returns:

a CatalogingRulesManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCatalogingRules() is false

Compliance:

optional - This method must be implemented if supportsCatalogingRules() is true.