OSID Logo
OSID Specifications
authentication package
Version 3.0.0
Release Candidate Preview
Interfaceosid.authentication.AgencyQueryInspector
Implementsosid.OsidCatalogQueryInspector
Description

This is the query inspector for examining queries.

MethodgetAgentIdTerms
Description

Gets the agent Id terms.

Returnosid.search.terms.IdTerm[]the agent Id terms
CompliancemandatoryThis method must be implemented.
MethodgetAgentTerms
Description

Gets the agent terms.

Returnosid.authentication.AgentQueryInspector[]the query terms
CompliancemandatoryThis method must be implemented.
MethodgetAncestorAgencyIdTerms
Description

Gets the ancestor agency Id terms.

Returnosid.search.terms.IdTerm[]the ancestor agency Id terms
CompliancemandatoryThis method must be implemented.
MethodgetAncestorAgencyTerms
Description

Gets the ancestor agency terms.

Returnosid.authentication.AgencyQueryInspector[]the ancestor agency terms
CompliancemandatoryThis method must be implemented.
MethodgetDescendantAgencyIdTerms
Description

Gets the descendant agency Id terms.

Returnosid.search.terms.IdTerm[]the descendant agency Id terms
CompliancemandatoryThis method must be implemented.
MethodgetDescendantAgencyTerms
Description

Gets the descendant agency terms.

Returnosid.authentication.AgencyQueryInspector[]the descendant agency terms
CompliancemandatoryThis method must be implemented.
MethodgetAgencyQueryInspectorRecord
Description

Gets the agency query inspector record corresponding to the given Agency record Type.

Parametersosid.type.TypeagencyRecordTypean agency record type
Returnosid.authentication.records.AgencyQueryInspectorRecordthe agency query inspector record
ErrorsNULL_ARGUMENT agencyRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(agencyRecordType) is false
CompliancemandatoryThis method must be implemented.