org.osid.cataloging

Interface CatalogingProfile

All Superinterfaces:

OsidProfile, Sourceable

All Known Subinterfaces:

CatalogingManager, CatalogingProxyManager

public interface CatalogingProfile
extends OsidProfile

The cataloging profile describes the interoperability among cataloging services.

Method Summary

Methods

Modifier and Type	Method and 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 billing federation is exposed.

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

supportsVisibleFederation

boolean supportsVisibleFederation()

Tests if any billing federation is exposed. Federation is exposed when a specific catalog may be identified, selected and used to create a lookup or admin session. Federation is not exposed when a set of catalogs appears as a single catalog.

Returns:

true if visible federation is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsCatalog

boolean supportsCatalog()

Tests for the availability of a cataloging service retrieving Id to Catalog mappings.

Returns:

true if cataloging is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsCatalogAssignment

boolean supportsCatalogAssignment()

Tests for the availability of a cataloging service for mapping Ids to Catalogs.

Returns:

true if catalog assignment is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsCatalogEntryNotification

boolean supportsCatalogEntryNotification()

Tests for the availability of a cataloging notification service for mapping Ids to Catalogs.

Returns:

true if catalog entry notification is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsCatalogLookup

boolean supportsCatalogLookup()

Tests for the availability of a catalog lookup service.

Returns:

true if catalog lookup is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsCatalogQuery

boolean supportsCatalogQuery()

Tests for the availability of a catalog query service that defines more comprehensive queries.

Returns:

true if catalog query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsCatalogSearch

boolean supportsCatalogSearch()

Tests for the availability of a catalog search service that defines more comprehensive queries.

Returns:

true if catalog search is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsCatalogAdmin

boolean supportsCatalogAdmin()

Tests for the availability of a catalog administration service for the addition and deletion of catalogs.

Returns:

true if catalog administration is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsCatalogNotification

boolean supportsCatalogNotification()

Tests for the availability of a catalog notification service.

Returns:

true if catalog notification is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsCatalogHierarchy

boolean supportsCatalogHierarchy()

Tests for the availability of a catalog hierarchy traversal service.

Returns:

true if catalog hierarchy traversal is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsCatalogHierarchyDesign

boolean supportsCatalogHierarchyDesign()

Tests for the availability of a catalog hierarchy design service.

Returns:

true if catalog hierarchy design is available, false otherwise

Compliance:

mandatory - This method must be implemented in all providers.

supportsCatalogingRules

boolean supportsCatalogingRules()

Tests if the cataloging rules sub services is supported.

Returns:

true if cataloging rules is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

getCatalogRecordTypes

TypeList getCatalogRecordTypes()

Gets the supported Catalog record types.

Returns:

a list containing the supported Catalog record types

Compliance:

mandatory - This method must be implemented.

supportsCatalogRecordType

boolean supportsCatalogRecordType(Type catalogRecordType)

Tests if the given Catalog record type is supported.

Parameters:

catalogRecordType - a Type indicating a Catalog record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - catalogRecordType is null

Compliance:

mandatory - This method must be implemented.

getCatalogSearchRecordTypes

TypeList getCatalogSearchRecordTypes()

Gets the supported catalog search reciord types.

Returns:

a list containing the supported search record types

Compliance:

mandatory - This method must be implemented.

supportsCatalogSearchRecordType

boolean supportsCatalogSearchRecordType(Type catalogSearchRecordType)

Tests if the given catalog search record type is supported.

Parameters:

catalogSearchRecordType - a Type indicating a catalog search record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - catalogSearchRecordType is null

Compliance:

mandatory - This method must be implemented.