OSID Logo
OSID Specifications
hold rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.hold.rules.HoldRulesProfile
Implementsosid.OsidProfile
Description

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

MethodsupportsVisibleFederation
Description

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.

Returnboolean true if visible federation is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsHoldEnablerLookup
Description

Tests if looking up hold enablers is supported.

Returnboolean true if hold enabler lookup is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsHoldEnablerQuery
Description

Tests if querying hold enablers is supported.

Returnboolean true if hold enabler query is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsHoldEnablerSearch
Description

Tests if searching hold enablers is supported.

Returnboolean true if hold enabler search is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsHoldEnablerAdmin
Description

Tests if a hold enabler administrative service is supported.

Returnboolean true if hold enabler administration is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsHoldEnablerNotification
Description

Tests if a hold enabler notification service is supported.

Returnboolean true if hold enabler notification is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsHoldEnablerOubliette
Description

Tests if a hold enabler oubliette lookup service is supported.

Returnboolean true if an oubliette enabler hold lookup service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsHoldEnablerOublietteAssignment
Description

Tests if a hold enabler oubliette service is supported.

Returnboolean true if hold enabler oubliette assignment service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsHoldEnablerSmartHold
Description

Tests if a hold enabler hold lookup service is supported.

Returnboolean true if a hold enabler hold service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsHoldEnablerRuleLookup
Description

Tests if a hold enabler rule lookup service is supported.

Returnboolean true if a hold enabler rule lookup service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsHoldEnablerRuleApplication
Description

Tests if a hold enabler rule application service is supported.

Returnboolean true if hold enabler rule application service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetHoldEnablerRecordTypes
Description

Gets the supported HoldEnabler record types.

Returnosid.type.TypeLista list containing the supported HoldEnabler record types
CompliancemandatoryThis method must be implemented.
MethodsupportsHoldEnablerRecordType
Description

Tests if the given HoldEnabler record type is supported.

Parametersosid.type.TypeholdEnablerRecordTypea Type indicating a HoldEnabler record type
Returnboolean true if the given record type is supported, false otherwise
ErrorsNULL_ARGUMENT holdEnablerRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetHoldEnablerSearchRecordTypes
Description

Gets the supported HoldEnabler search record types.

Returnosid.type.TypeLista list containing the supported HoldEnabler search record types
CompliancemandatoryThis method must be implemented.
MethodsupportsHoldEnablerSearchRecordType
Description

Tests if the given HoldEnabler search record type is supported.

Parametersosid.type.TypeholdEnablerSearchRecordTypea Type indicating a HoldEnabler search record type
Returnboolean true if the given search record type is supported, false otherwise
ErrorsNULL_ARGUMENT holdEnablerSearchRecordType is null
CompliancemandatoryThis method must be implemented.