Interface | osid.hold.rules.HoldEnablerSearchSession | ||
---|---|---|---|
Implements | osid.hold.rules.HoldEnablerQuerySession | ||
Description |
This session provides methods for searching among This session defines views that offer differing behaviors for searching.
| ||
Method | getHoldEnablerSearch | ||
Description |
Gets a hold enabler search. | ||
Return | osid.hold.rules.HoldEnablerSearch | the hold enabler search | |
Compliance | mandatory | This method must be implemented. | |
Method | getHoldEnablerSearchOrder | ||
Description |
Gets a hold enabler search order. The | ||
Return | osid.hold.rules.HoldEnablerSearchOrder | the hold enabler search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getHoldEnablersBySearch | ||
Description |
Gets the search results matching the given search query using the given search. | ||
Parameters | osid.hold.rules.HoldEnablerQuery | holdEnablerQuery | the hold enabler query |
osid.hold.rules.HoldEnablerSearch | holdEnablerSearch | the hold enabler search | |
Return | osid.hold.rules.HoldEnablerSearchResults | the returned search results | |
Errors | NULL_ARGUMENT | holdEnablerQuery or holdEnablerSearch is
null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | holdEnablerQuery or holdEnablerSearch is not
of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getHoldEnablerQueryFromInspector | ||
Description |
Gets a hold enabler query from an inspector. The
inspector is available from a | ||
Parameters | osid.hold.rules.HoldEnablerQueryInspector | holdEnablerQueryInspector | a hold enabler query inspector |
Return | osid.hold.rules.HoldEnablerQuery | the hold enabler query | |
Errors | NULL_ARGUMENT | holdEnablerQueryInspector is null | |
UNSUPPORTED | holdEnablerQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |