org.osid.cataloging.rules

Interface CatalogingRulesProfile

All Superinterfaces:

OsidProfile, Sourceable

All Known Subinterfaces:

CatalogingRulesManager, CatalogingRulesProxyManager

public interface CatalogingRulesProfile
extends OsidProfile

The cataloging rules profile describes the interoperability among cataloging rules services.

Method Summary

Methods

Modifier and Type	Method and Description
TypeList	getCatalogEnablerRecordTypes() Gets the supported CatalogEnabler record types.
TypeList	getCatalogEnablerSearchRecordTypes() Gets the supported CatalogEnabler search record types.
boolean	supportsCatalogEnablerAdmin() Tests if a catalog enabler administrative service is supported.
boolean	supportsCatalogEnablerCatalog() Tests if a catalog enabler catalog lookup service is supported.
boolean	supportsCatalogEnablerCatalogAssignment() Tests if a catalog enabler catalog service is supported.
boolean	supportsCatalogEnablerLookup() Tests if looking up catalog enablers is supported.
boolean	supportsCatalogEnablerNotification() Tests if a catalog enabler notification service is supported.
boolean	supportsCatalogEnablerQuery() Tests if querying catalog enablers is supported.
boolean	supportsCatalogEnablerRecordType(Type catalogEnablerRecordType) Tests if the given CatalogEnabler record type is supported.
boolean	supportsCatalogEnablerRuleApplication() Tests if a catalog enabler rule application service is supported.
boolean	supportsCatalogEnablerRuleLookup() Tests if a catalog enabler rule lookup service is supported.
boolean	supportsCatalogEnablerSearch() Tests if searching catalog enablers is supported.
boolean	supportsCatalogEnablerSearchRecordType(Type catalogEnablerSearchRecordType) Tests if the given CatalogEnabler search record type is supported.
boolean	supportsCatalogEnablerSmartCatalog() Tests if a catalog enabler catalog lookup service is supported.
boolean	supportsVisibleFederation() Tests if any broker 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 broker federation is exposed. Federation is exposed when a specific broker may be identified, selected and used to create a lookup or admin session. Federation is not exposed when a set of brokers appears as a single broker.

Returns:

true if visible federation is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsCatalogEnablerLookup

boolean supportsCatalogEnablerLookup()

Tests if looking up catalog enablers is supported.

Returns:

true if catalog enabler lookup is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsCatalogEnablerQuery

boolean supportsCatalogEnablerQuery()

Tests if querying catalog enablers is supported.

Returns:

true if catalog enabler query is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsCatalogEnablerSearch

boolean supportsCatalogEnablerSearch()

Tests if searching catalog enablers is supported.

Returns:

true if catalog enabler search is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsCatalogEnablerAdmin

boolean supportsCatalogEnablerAdmin()

Tests if a catalog enabler administrative service is supported.

Returns:

true if catalog enabler administration is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsCatalogEnablerNotification

boolean supportsCatalogEnablerNotification()

Tests if a catalog enabler notification service is supported.

Returns:

true if catalog enabler notification is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsCatalogEnablerCatalog

boolean supportsCatalogEnablerCatalog()

Tests if a catalog enabler catalog lookup service is supported.

Returns:

true if a catalog enabler catalog lookup service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsCatalogEnablerCatalogAssignment

boolean supportsCatalogEnablerCatalogAssignment()

Tests if a catalog enabler catalog service is supported.

Returns:

true if catalog enabler catalog assignment service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsCatalogEnablerSmartCatalog

boolean supportsCatalogEnablerSmartCatalog()

Tests if a catalog enabler catalog lookup service is supported.

Returns:

true if a catalog enabler catalog service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsCatalogEnablerRuleLookup

boolean supportsCatalogEnablerRuleLookup()

Tests if a catalog enabler rule lookup service is supported.

Returns:

true if a catalog enabler rule lookup service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsCatalogEnablerRuleApplication

boolean supportsCatalogEnablerRuleApplication()

Tests if a catalog enabler rule application service is supported.

Returns:

true if catalog enabler rule application service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

getCatalogEnablerRecordTypes

TypeList getCatalogEnablerRecordTypes()

Gets the supported CatalogEnabler record types.

Returns:

a list containing the supported CatalogEnabler record types

Compliance:

mandatory - This method must be implemented.

supportsCatalogEnablerRecordType

boolean supportsCatalogEnablerRecordType(Type catalogEnablerRecordType)

Tests if the given CatalogEnabler record type is supported.

Parameters:

catalogEnablerRecordType - a Type indicating a CatalogEnabler record type

Returns:

true if the given record type is supported, false otherwise

Throws:

NullArgumentException - catalogEnablerRecordType is null

Compliance:

mandatory - This method must be implemented.

getCatalogEnablerSearchRecordTypes

TypeList getCatalogEnablerSearchRecordTypes()

Gets the supported CatalogEnabler search record types.

Returns:

a list containing the supported CatalogEnabler search record types

Compliance:

mandatory - This method must be implemented.

supportsCatalogEnablerSearchRecordType

boolean supportsCatalogEnablerSearchRecordType(Type catalogEnablerSearchRecordType)

Tests if the given CatalogEnabler search record type is supported.

Parameters:

catalogEnablerSearchRecordType - a Type indicating a CatalogEnabler search record type

Returns:

true if the given search record type is supported, false otherwise

Throws:

NullArgumentException - catalogEnablerSearchRecordType is null

Compliance:

mandatory - This method must be implemented.