OSID Logo
OSID Specifications
authentication package
Version 3.0.0
Release Candidate Preview
Interfaceosid.authentication.AgentSmartAgencySession
Implementsosid.OsidSession
Description

This session manages queries and sequencing to create "smart" dynamic catalogs. An AgentQuery can be retrieved from this session and mapped to this Agency to create a virtual collection of Agents. The agents may be sequenced using the AgentSearchOrder from this session.

This Agency has a default query that matches any agent and a default search order that specifies no sequencing. The queries may be examined using an AgentQueryInspector. The query may be modified by converting the inspector back to an AgentQuery.

MethodgetAgencyId
Description

Gets the Agency Id associated with this session.

Returnosid.id.Idthe Agency Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetAgency
Description

Gets the Agency associated with this session.

Returnosid.authentication.Agencythe Agency associated with this session
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageSmartAgencies
Description

Tests if this user can manage smart agencies. A return of true does not guarantee successful authorization. A return of false indicates that it is known methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer operations to unauthorized users.

Returnboolean false if smart agency management is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetAgentQuery
Description

Gets an agent query.

Returnosid.authentication.AgentQuerythe agent query
CompliancemandatoryThis method must be implemented.
MethodgetAgentSearchOrder
Description

Gets an agent search order.

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

Applies an agent query to this agency.

Parametersosid.authentication.AgentQueryagentQuerythe agent query
ErrorsNULL_ARGUMENT agentQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED agentQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectAgentQuery
Description

Gets an agent query inspector for this agency.

Returnosid.authentication.AgentQueryInspectorthe agent query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyAgentSequencing
Description

Applies an agent search order to this agency.

Parametersosid.authentication.AgentSearchOrderagentSearchOrderthe agent search order
ErrorsNULL_ARGUMENT agentSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED agentSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetAgentQueryFromInspector
Description

Gets an agent query from an inspector.

Parametersosid.authentication.AgentQueryInspectoragentQueryInspectora query inspector
Returnosid.authentication.AgentQuerythe agent query
ErrorsNULL_ARGUMENT agentQueryInspector is null
UNSUPPORTED agentQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.