Interface | osid.hold.rules.HoldRulesProfile | ||
---|---|---|---|
Implements | osid.OsidProfile | ||
Description |
The hold rules profile describes the interoperability among hold rules services. | ||
Method | supportsVisibleFederation | ||
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. | ||
Return | boolean | true if visible federation is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsHoldEnablerLookup | ||
Description |
Tests if looking up hold enablers is supported. | ||
Return | boolean | true if hold enabler lookup is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsHoldEnablerQuery | ||
Description |
Tests if querying hold enablers is supported. | ||
Return | boolean | true if hold enabler query is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsHoldEnablerSearch | ||
Description |
Tests if searching hold enablers is supported. | ||
Return | boolean | true if hold enabler search is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsHoldEnablerAdmin | ||
Description |
Tests if a hold enabler administrative service is supported. | ||
Return | boolean | true if hold enabler administration is supported,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsHoldEnablerNotification | ||
Description |
Tests if a hold enabler notification service is supported. | ||
Return | boolean | true if hold enabler notification is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsHoldEnablerOubliette | ||
Description |
Tests if a hold enabler oubliette lookup service is supported. | ||
Return | boolean | true if an oubliette enabler hold lookup service is
supported, false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsHoldEnablerOublietteAssignment | ||
Description |
Tests if a hold enabler oubliette service is supported. | ||
Return | boolean | true if hold enabler oubliette assignment service is
supported, false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsHoldEnablerSmartHold | ||
Description |
Tests if a hold enabler hold lookup service is supported. | ||
Return | boolean | true if a hold enabler hold service is supported,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsHoldEnablerRuleLookup | ||
Description |
Tests if a hold enabler rule lookup service is supported. | ||
Return | boolean | true if a hold enabler rule lookup service is supported,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsHoldEnablerRuleApplication | ||
Description |
Tests if a hold enabler rule application service is supported. | ||
Return | boolean | true if hold enabler rule application service is supported,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getHoldEnablerRecordTypes | ||
Description |
Gets the supported | ||
Return | osid.type.TypeList | a list containing the supported HoldEnabler record types | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsHoldEnablerRecordType | ||
Description |
Tests if the given | ||
Parameters | osid.type.Type | holdEnablerRecordType | a Type indicating a HoldEnabler record type |
Return | boolean | true if the given record type is supported, false
otherwise | |
Errors | NULL_ARGUMENT | holdEnablerRecordType is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getHoldEnablerSearchRecordTypes | ||
Description |
Gets the supported | ||
Return | osid.type.TypeList | a list containing the supported HoldEnabler search record
types | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsHoldEnablerSearchRecordType | ||
Description |
Tests if the given | ||
Parameters | osid.type.Type | holdEnablerSearchRecordType | a Type indicating a HoldEnabler search record
type |
Return | boolean | true if the given search record type is supported,
false otherwise | |
Errors | NULL_ARGUMENT | holdEnablerSearchRecordType is null | |
Compliance | mandatory | This method must be implemented. |