org.osid.hold.rules

Interface HoldRulesProfile

All Superinterfaces:

OsidProfile, Sourceable

All Known Subinterfaces:

HoldRulesManager, HoldRulesProxyManager

public interface HoldRulesProfile
extends OsidProfile

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

Method Summary

Methods

Modifier and Type	Method and Description
TypeList	getHoldEnablerRecordTypes() Gets the supported HoldEnabler record types.
TypeList	getHoldEnablerSearchRecordTypes() Gets the supported HoldEnabler search record types.
boolean	supportsHoldEnablerAdmin() Tests if a hold enabler administrative service is supported.
boolean	supportsHoldEnablerLookup() Tests if looking up hold enablers is supported.
boolean	supportsHoldEnablerNotification() Tests if a hold enabler notification service is supported.
boolean	supportsHoldEnablerOubliette() Tests if a hold enabler oubliette lookup service is supported.
boolean	supportsHoldEnablerOublietteAssignment() Tests if a hold enabler oubliette service is supported.
boolean	supportsHoldEnablerQuery() Tests if querying hold enablers is supported.
boolean	supportsHoldEnablerRecordType(Type holdEnablerRecordType) Tests if the given HoldEnabler record type is supported.
boolean	supportsHoldEnablerRuleApplication() Tests if a hold enabler rule application service is supported.
boolean	supportsHoldEnablerRuleLookup() Tests if a hold enabler rule lookup service is supported.
boolean	supportsHoldEnablerSearch() Tests if searching hold enablers is supported.
boolean	supportsHoldEnablerSearchRecordType(Type holdEnablerSearchRecordType) Tests if the given HoldEnabler search record type is supported.
boolean	supportsHoldEnablerSmartHold() Tests if a hold enabler hold 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.

supportsHoldEnablerLookup

boolean supportsHoldEnablerLookup()

Tests if looking up hold enablers is supported.

Returns:

true if hold enabler lookup is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsHoldEnablerQuery

boolean supportsHoldEnablerQuery()

Tests if querying hold enablers is supported.

Returns:

true if hold enabler query is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsHoldEnablerSearch

boolean supportsHoldEnablerSearch()

Tests if searching hold enablers is supported.

Returns:

true if hold enabler search is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsHoldEnablerAdmin

boolean supportsHoldEnablerAdmin()

Tests if a hold enabler administrative service is supported.

Returns:

true if hold enabler administration is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsHoldEnablerNotification

boolean supportsHoldEnablerNotification()

Tests if a hold enabler notification service is supported.

Returns:

true if hold enabler notification is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsHoldEnablerOubliette

boolean supportsHoldEnablerOubliette()

Tests if a hold enabler oubliette lookup service is supported.

Returns:

true if an oubliette enabler hold lookup service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsHoldEnablerOublietteAssignment

boolean supportsHoldEnablerOublietteAssignment()

Tests if a hold enabler oubliette service is supported.

Returns:

true if hold enabler oubliette assignment service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsHoldEnablerSmartHold

boolean supportsHoldEnablerSmartHold()

Tests if a hold enabler hold lookup service is supported.

Returns:

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

Compliance:

mandatory - This method must be implemented.

supportsHoldEnablerRuleLookup

boolean supportsHoldEnablerRuleLookup()

Tests if a hold enabler rule lookup service is supported.

Returns:

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

Compliance:

mandatory - This method must be implemented.

supportsHoldEnablerRuleApplication

boolean supportsHoldEnablerRuleApplication()

Tests if a hold enabler rule application service is supported.

Returns:

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

Compliance:

mandatory - This method must be implemented.

getHoldEnablerRecordTypes

TypeList getHoldEnablerRecordTypes()

Gets the supported HoldEnabler record types.

Returns:

a list containing the supported HoldEnabler record types

Compliance:

mandatory - This method must be implemented.

supportsHoldEnablerRecordType

boolean supportsHoldEnablerRecordType(Type holdEnablerRecordType)

Tests if the given HoldEnabler record type is supported.

Parameters:

holdEnablerRecordType - a Type indicating a HoldEnabler record type

Returns:

true if the given record type is supported, false otherwise

Throws:

NullArgumentException - holdEnablerRecordType is null

Compliance:

mandatory - This method must be implemented.

getHoldEnablerSearchRecordTypes

TypeList getHoldEnablerSearchRecordTypes()

Gets the supported HoldEnabler search record types.

Returns:

a list containing the supported HoldEnabler search record types

Compliance:

mandatory - This method must be implemented.

supportsHoldEnablerSearchRecordType

boolean supportsHoldEnablerSearchRecordType(Type holdEnablerSearchRecordType)

Tests if the given HoldEnabler search record type is supported.

Parameters:

holdEnablerSearchRecordType - a Type indicating a HoldEnabler search record type

Returns:

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

Throws:

NullArgumentException - holdEnablerSearchRecordType is null

Compliance:

mandatory - This method must be implemented.