Interface CatalogingProxyManager

All Superinterfaces:

AutoCloseable, CatalogingProfile, Closeable, OsidProfile, OsidProxyManager, 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

Modifier and Type	Method	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 CatalogingProfile

getCatalogRecordTypes, getCatalogSearchRecordTypes, supportsCatalog, supportsCatalogAdmin, supportsCatalogAssignment, supportsCatalogEntryNotification, supportsCatalogHierarchy, supportsCatalogHierarchyDesign, supportsCatalogingRules, supportsCatalogLookup, supportsCatalogNotification, supportsCatalogQuery, supportsCatalogRecordType, supportsCatalogSearch, supportsCatalogSearchRecordType, supportsVisibleFederation

Modifier and Type	Method	Description
TypeList	getCatalogRecordTypes()	Gets the supported Catalog record types.
TypeList	getCatalogSearchRecordTypes()	Gets the supported catalog search reciord types.
boolean	supportsCatalog()	Tests for the availability of a cataloging service retrieving Id to Catalog mappings.
boolean	supportsCatalogAdmin()	Tests for the availability of a catalog administration service for the addition and deletion of catalogs.
boolean	supportsCatalogAssignment()	Tests for the availability of a cataloging service for mapping Ids to Catalogs .
boolean	supportsCatalogEntryNotification()	Tests for the availability of a cataloging notification service for mapping Ids to Catalogs .
boolean	supportsCatalogHierarchy()	Tests for the availability of a catalog hierarchy traversal service.
boolean	supportsCatalogHierarchyDesign()	Tests for the availability of a catalog hierarchy design service.
boolean	supportsCatalogingRules()	Tests if the cataloging rules sub services is supported.
boolean	supportsCatalogLookup()	Tests for the availability of a catalog lookup service.
boolean	supportsCatalogNotification()	Tests for the availability of a catalog notification service.
boolean	supportsCatalogQuery()	Tests for the availability of a catalog query service that defines more comprehensive queries.
boolean	supportsCatalogRecordType(Type catalogRecordType)	Tests if the given Catalog record type is supported.
boolean	supportsCatalogSearch()	Tests for the availability of a catalog search service that defines more comprehensive queries.
boolean	supportsCatalogSearchRecordType(Type catalogSearchRecordType)	Tests if the given catalog search record type is supported.
boolean	supportsVisibleFederation()	Tests if any cataloging federation is exposed.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidProfile

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

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
TypeList	getProxyRecordTypes()	Gets the proxy record Types supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface OsidProxyManager

close

Modifier and Type	Method	Description
void	close()	Close this manager.

Methods inherited from interface OsidProxyManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId, Proxy proxy)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime, Proxy proxy)	Rolls back this service to a point in time.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids .
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

Method Details

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 {@code supportsCatalog()} is {@code 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 {@code supportsCatalogAssignment()} is {@code 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 {@code supportsCatalogEntryNotification()} is {@code 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 {@code supportsCatalogEntryNotification()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsCatalogLookup()} is {@code 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 {@code supportsCatalogQuery()} is {@code 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 {@code supportsCatalogSearch()} is {@code 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 {@code supportsCatalogAdmin()} is {@code 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 {@code supportsCatalogNotification()} is {@code 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 {@code supportsCatalogHierarchy()} is {@code 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 {@code supportsCatalogHierarchyDesign()} is {@code 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 {@code supportsCatalogingRules()} is {@code true} .