OSID Logo
OSID Specifications
authentication package
Version 3.0.0
Release Candidate Preview
Interfaceosid.authentication.AgentSearchSession
Implementsosid.authentication.AgentQuerySession
Description

This session provides methods for searching Agents. The search query is constructed using the AgentQuery. The agent record Type also specifies the record for the agent query.

getAgentsByQuery() is the basic search method and returns a list of Agents. A more advanced search may be performed with getAgentsBySearch(). It accepts an AgentSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getAgentsBySearch() returns an AgentSearchResults that can be used to access the resulting AgentList or be used to perform a search within the result set through AgentSearch.

This session defines views that offer differing behaviors for searching.

  • federated agency view: searches include agents in agencies of which this agency is a ancestor in the agency hierarchy
  • isolated agency view: searches are restricted to agents in this agency

Agents may have an agent query record indicated by their respective record types. The agent query record is accessed via the AgentQuery.

MethodgetAgentSearch
Description

Gets an agent search.

Returnosid.authentication.AgentSearchthe agent search
CompliancemandatoryThis method must be implemented.
MethodgetAgentSearchOrder
Description

Gets an agent search order. The AgentSearchOrder is supplied to an AgentSearch to specify the ordering of results.

Returnosid.authentication.AgentSearchOrderthe agent search order
CompliancemandatoryThis method must be implemented.
MethodgetAgentsBySearch
Description

Gets the search results matching the given search query using the given search.

Parametersosid.authentication.AgentQueryagentQuerythe agent query
osid.authentication.AgentSearchagentSearchthe agent search
Returnosid.authentication.AgentSearchResultsthe returned search results
ErrorsNULL_ARGUMENT agentQuery or agentSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED agentSearch or agentQuery is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetAgentQueryFromInspector
Description

Gets an agent query from an inspector. The inspector is available from an AgentSearchResults.

Parametersosid.authentication.AgentQueryInspectoragentQueryInspectoran agent query inspector
Returnosid.authentication.AgentQuerythe agent query
ErrorsNULL_ARGUMENT agentQueryInspector is null
UNSUPPORTED agentQueryInspector is not of thiss ervice
CompliancemandatoryThis method must be implemented.