Interface | osid.authentication.keys.KeyQuery | ||
---|---|---|---|
Implements | osid.OsidObjectQuery | ||
Description |
This is the query for searching keys. Each method specifies
an | ||
Method | matchAgentId | ||
Description |
Sets the agent | ||
Parameters | osid.id.Id | agentId | an agent Id |
boolean | match | true for a positive match, false for 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 |
Includes an agent query for making relations with
| ||
Return | osid.authentication.AgentQuery | the agent query | |
Errors | UNIMPLEMENTED | supportsAgentQuery() is false | |
Compliance | mandatory | This method must be implemented. | |
Method | clearAgentTerms | ||
Description |
Clears the agent terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | getKeyQueryRecord | ||
Description |
Gets the key query record corresponding to the given
| ||
Parameters | osid.type.Type | keyRecordType | a key record type |
Return | osid.authentication.keys.records.KeyQueryRecord | the key query record | |
Errors | NULL_ARGUMENT | keyRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(keyRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |