Interface | osid.hold.HoldQuery | ||
---|---|---|---|
Implements | osid.OsidRelationshipQuery | ||
Description |
This is the query for searching holds. Each method match
specifies an | ||
Method | matchResourceId | ||
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 | clearResourceIdTerms | ||
Description |
Clears the resource | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsResourceQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a resource query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getResourceQuery | ||
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 | matchAnyResource | ||
Description |
Matches holds that have any resource defined. | ||
Parameters | boolean | match | true to match holds with any resources, false
to match holds with no resources |
Compliance | mandatory | This method must be implemented. | |
Method | clearResourceTerms | ||
Description |
Clears the resource query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchAgentId | ||
Description |
Sets the agent | ||
Parameters | osid.id.Id | agentId | the agent Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | agentId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearAgentIdTerms | ||
Description |
Clears the agent | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsAgentQuery | ||
Description |
Tests if an | ||
Return | boolean | true if an agent query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getAgentQuery | ||
Description |
Gets the query for an agent. Multiple retrievals
produce a nested | ||
Return | osid.authentication.AgentQuery | the agent query | |
Errors | UNIMPLEMENTED | supportsAgentQuery() is false | |
Compliance | optional | This method must be implemented if supportsAgentQuery() is
true. | |
Method | matchAnyAgent | ||
Description |
Matches holds that have any agent defined. | ||
Parameters | boolean | match | true to match holds with any agents, false to
match holds with no agents |
Compliance | mandatory | This method must be implemented. | |
Method | clearAgentTerms | ||
Description |
Clears the agent query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchIssueId | ||
Description |
Sets the issue | ||
Parameters | osid.id.Id | issueId | the issue Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | issueId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearIssueIdTerms | ||
Description |
Clears the issue | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsIssueQuery | ||
Description |
Tests if an | ||
Return | boolean | true if an issue query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getIssueQuery | ||
Description |
Gets the query for an issue. Multiple retrievals
produce a nested | ||
Return | osid.hold.IssueQuery | the issue query | |
Errors | UNIMPLEMENTED | supportsIssueQuery() is false | |
Compliance | optional | This method must be implemented if supportsIssueQuery() is
true. | |
Method | clearIssueTerms | ||
Description |
Clears the issue 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 | getHoldQueryRecord | ||
Description |
Gets the hold query record corresponding to the given
| ||
Parameters | osid.type.Type | holdRecordType | a hold record type |
Return | osid.hold.records.HoldQueryRecord | the hold query record | |
Errors | NULL_ARGUMENT | holdRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | hasRecordType(holdRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |