Interface | osid.hold.IssueQuery | ||
---|---|---|---|
Implements | osid.OsidObjectQuery | ||
Description |
This is the query for searching issues. Each method match
specifies an | ||
Method | matchBureauId | ||
Description |
Sets the resource | ||
Parameters | osid.id.Id | resourceId | the resource Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | resourceId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearBureauIdTerms | ||
Description |
Clears the resource | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsBureauQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a resource query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getBureauQuery | ||
Description |
Gets the query for a resource. Multiple retrievals
produce a nested | ||
Return | osid.resource.ResourceQuery | the resource query | |
Errors | UNIMPLEMENTED | supportsResourceQuery() is false | |
Compliance | optional | This method must be implemented if supportsResourceQuery()
is true. | |
Method | clearBureauTerms | ||
Description |
Clears the resource query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchBlockId | ||
Description |
Sets the block | ||
Parameters | osid.id.Id | blockId | the block Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | blockId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearBlockIdTerms | ||
Description |
Clears the block | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsBlockQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a block query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getBlockQuery | ||
Description |
Gets the query for a block. Multiple retrievals produce
a nested | ||
Return | osid.hold.BlockQuery | the block query | |
Errors | UNIMPLEMENTED | supportsBlockQuery() is false | |
Compliance | optional | This method must be implemented if supportsBlockQuery() is
true. | |
Method | matchAnyBlock | ||
Description |
Matches issues used for any block. | ||
Parameters | boolean | match | true to match issues with any blocks, false
to match issues with no blocks |
Compliance | mandatory | This method must be implemented. | |
Method | clearBlockTerms | ||
Description |
Clears the block query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchHoldId | ||
Description |
Sets 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 | clearHoldIdTerms | ||
Description |
Clears the hold | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsHoldQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a hold query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getHoldQuery | ||
Description |
Gets the query for a hold. Multiple retrievals produce
a nested | ||
Return | osid.hold.HoldQuery | the hold query | |
Errors | UNIMPLEMENTED | supportsHoldQuery() is false | |
Compliance | optional | This method must be implemented if supportsHoldQuery() is
true. | |
Method | matchAnyHold | ||
Description |
Matches issues referenced by any hold. | ||
Parameters | boolean | match | true to match issues with any holds, false to
match issues with no holds |
Compliance | mandatory | This method must be implemented. | |
Method | clearHoldTerms | ||
Description |
Clears the hold query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchOublietteId | ||
Description |
Sets 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 | getIssueQueryRecord | ||
Description |
Gets the issue query record corresponding to the given
| ||
Parameters | osid.type.Type | issueRecordType | an issue record type |
Return | osid.hold.records.IssueQueryRecord | the issue query record | |
Errors | NULL_ARGUMENT | issueRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | hasRecordType(issueRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |