Interface | osid.authentication.AgencyQuery | ||
---|---|---|---|
Implements | osid.OsidCatalogQuery | ||
Description |
This is the query for searching agencies. 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 |
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 agencies with any agent. | ||
Parameters | boolean | match | true to match agencies with any agent. false
to match agencies with no agents |
Compliance | mandatory | This method must be implemented. | |
Method | clearAgentTerms | ||
Description |
Clears the agent terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchAncestorAgencyId | ||
Description |
Sets the agency | ||
Parameters | osid.id.Id | agencyId | an agency Id |
boolean | match | true for a positive match, false for negative
match | |
Errors | NULL_ARGUMENT | agencyId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearAncestorAgencyIdTerms | ||
Description |
Clears the ancestor agency | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsAncestorAgencyQuery | ||
Description |
Tests if an | ||
Return | boolean | true if an agency query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getAncestorAgencyQuery | ||
Description |
Gets the query for an agency. Multiple retrievals
produce a nested | ||
Return | osid.authentication.AgentQuery | the agency query | |
Errors | UNIMPLEMENTED | supportsAncestorAgencyQuery() is false | |
Compliance | optional | This method must be implemented if supportsAncestorAgencyQuery()
is true. | |
Method | matchAnyAncestorAgency | ||
Description |
Matches agencies with any ancestor. | ||
Parameters | boolean | match | true to match agencies with any ancestor, false
to match root agencies |
Compliance | mandatory | This method must be implemented. | |
Method | clearAncestorAgencyTerms | ||
Description |
Clears the ancestor agency terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchDescendantAgencyId | ||
Description |
Sets the agency | ||
Parameters | osid.id.Id | agencyId | an agency Id |
boolean | match | true for a positive match, false for negative
match | |
Errors | NULL_ARGUMENT | agencyId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearDescendantAgencyIdTerms | ||
Description |
Clears the descendant agency | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsDescendantAgencyQuery | ||
Description |
Tests if an | ||
Return | boolean | true if an agency query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getDescendantAgencyQuery | ||
Description |
Gets the query for an agency. Multiple retrievals
produce a nested | ||
Return | osid.authentication.AgentQuery | the agency query | |
Errors | UNIMPLEMENTED | supportsDescendantAgencyQuery() is false | |
Compliance | optional | This method must be implemented if supportsDescendantAgencyQuery()
is true. | |
Method | matchAnyDescendantAgency | ||
Description |
Matches agencies with any descendant. | ||
Parameters | boolean | match | true to match agencies with any descendant, false
to match leaf agencies |
Compliance | mandatory | This method must be implemented. | |
Method | clearDescendantAgencyTerms | ||
Description |
Clears the descendant agency terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAgencyQueryRecord | ||
Description |
Gets the agency query record corresponding to the given
| ||
Parameters | osid.type.Type | agencyRecordType | an agency record type |
Return | osid.authentication.records.AgencyQueryRecord | the agency query record | |
Errors | NULL_ARGUMENT | agencyRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(agencyRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |