OSID Logo
OSID Specifications
authentication package
Version 3.0.0
Release Candidate Preview
Interfaceosid.authentication.AgencyQuery
Implementsosid.OsidCatalogQuery
Description

This is the query for searching agencies. Each method specifies an AND term while multiple invocations of the same method produce a nested OR.

MethodmatchAgentId
Description

Sets the agent Id for this query.

Parametersosid.id.IdagentIdan agent Id
booleanmatch true for a positive match, false for negative match
ErrorsNULL_ARGUMENT agentId is null
CompliancemandatoryThis method must be implemented.
MethodclearAgentIdTerms
Description

Clears the agent Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsAgentQuery
Description

Tests if an AgentQuery is available.

Returnboolean true if an agent query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetAgentQuery
Description

Gets the query for an agent. Multiple retrievals produce a nested OR term.

Returnosid.authentication.AgentQuerythe agent query
ErrorsUNIMPLEMENTED supportsAgentQuery() is false
ComplianceoptionalThis method must be implemented if supportsAgentQuery() is true.
MethodmatchAnyAgent
Description

Matches agencies with any agent.

Parametersbooleanmatch true to match agencies with any agent. false to match agencies with no agents
CompliancemandatoryThis method must be implemented.
MethodclearAgentTerms
Description

Clears the agent terms.

CompliancemandatoryThis method must be implemented.
MethodmatchAncestorAgencyId
Description

Sets the agency Id for this query to match agencies that have the specified agency as an ancestor.

Parametersosid.id.IdagencyIdan agency Id
booleanmatch true for a positive match, false for negative match
ErrorsNULL_ARGUMENT agencyId is null
CompliancemandatoryThis method must be implemented.
MethodclearAncestorAgencyIdTerms
Description

Clears the ancestor agency Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsAncestorAgencyQuery
Description

Tests if an AgencyQuery is available.

Returnboolean true if an agency query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetAncestorAgencyQuery
Description

Gets the query for an agency. Multiple retrievals produce a nested OR term.

Returnosid.authentication.AgentQuerythe agency query
ErrorsUNIMPLEMENTED supportsAncestorAgencyQuery() is false
ComplianceoptionalThis method must be implemented if supportsAncestorAgencyQuery() is true.
MethodmatchAnyAncestorAgency
Description

Matches agencies with any ancestor.

Parametersbooleanmatch true to match agencies with any ancestor, false to match root agencies
CompliancemandatoryThis method must be implemented.
MethodclearAncestorAgencyTerms
Description

Clears the ancestor agency terms.

CompliancemandatoryThis method must be implemented.
MethodmatchDescendantAgencyId
Description

Sets the agency Id for this query to match agencies that have the specified agency as an descendant.

Parametersosid.id.IdagencyIdan agency Id
booleanmatch true for a positive match, false for negative match
ErrorsNULL_ARGUMENT agencyId is null
CompliancemandatoryThis method must be implemented.
MethodclearDescendantAgencyIdTerms
Description

Clears the descendant agency Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsDescendantAgencyQuery
Description

Tests if an AgencyQuery is available.

Returnboolean true if an agency query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetDescendantAgencyQuery
Description

Gets the query for an agency. Multiple retrievals produce a nested OR term.

Returnosid.authentication.AgentQuerythe agency query
ErrorsUNIMPLEMENTED supportsDescendantAgencyQuery() is false
ComplianceoptionalThis method must be implemented if supportsDescendantAgencyQuery() is true.
MethodmatchAnyDescendantAgency
Description

Matches agencies with any descendant.

Parametersbooleanmatch true to match agencies with any descendant, false to match leaf agencies
CompliancemandatoryThis method must be implemented.
MethodclearDescendantAgencyTerms
Description

Clears the descendant agency terms.

CompliancemandatoryThis method must be implemented.
MethodgetAgencyQueryRecord
Description

Gets the agency query record corresponding to the given Agency record Type. Multiple record retrievals produce a nested OR term.

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