Interface | osid.hold.rules.HoldEnablerQuery | ||
---|---|---|---|
Implements | osid.OsidEnablerQuery | ||
Description |
This is the query for searching hold enablers. Each method
match specifies an | ||
Method | matchRuledHoldId | ||
Description |
Matches enablers mapped to the hold. | ||
Parameters | osid.id.Id | holdId | the hold Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | holdId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearRuledHoldIdTerms | ||
Description |
Clears the hold | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsRuledHoldQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a hold query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getRuledHoldQuery | ||
Description |
Gets the query for a hold. Multiple retrievals produce
a nested | ||
Return | osid.hold.HoldQuery | the hold query | |
Errors | UNIMPLEMENTED | supportsRuledHoldQuery() is false | |
Compliance | optional | This method must be implemented if supportsRuledHoldQuery()
is true. | |
Method | matchAnyRuledHold | ||
Description |
Matches enablers mapped to any hold. | ||
Parameters | boolean | match | true for enablers mapped to any hold, false
to match enablers mapped to no hold |
Compliance | mandatory | This method must be implemented. | |
Method | clearRuledHoldTerms | ||
Description |
Clears the hold query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchOublietteId | ||
Description |
Matches enablers mapped to the oubliette. | ||
Parameters | osid.id.Id | oublietteId | the oubliette Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | oublietteId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearOublietteIdTerms | ||
Description |
Clears the oubliette | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsOublietteQuery | ||
Description |
Tests if a | ||
Return | boolean | true if an oubliette query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getOublietteQuery | ||
Description |
Gets the query for an oubliette. Multiple retrievals
produce a nested | ||
Return | osid.hold.OublietteQuery | the oubliette query | |
Errors | UNIMPLEMENTED | supportsOublietteQuery() is false | |
Compliance | optional | This method must be implemented if supportsOublietteQuery()
is true. | |
Method | clearOublietteTerms | ||
Description |
Clears the oubliette query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | getHoldEnablerQueryRecord | ||
Description |
Gets the hold enabler query record corresponding to the
given | ||
Parameters | osid.type.Type | holdEnablerRecordType | a hold enabler record type |
Return | osid.hold.rules.records.HoldEnablerQueryRecord | the hold enabler query record | |
Errors | NULL_ARGUMENT | holdEnablerRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(holdEnablerRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |