Interface | osid.authentication.AgentSmartAgencySession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session manages queries and sequencing to create
"smart" dynamic catalogs. An This | ||
Method | getAgencyId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Agency Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getAgency | ||
Description |
Gets the | ||
Return | osid.authentication.Agency | the Agency associated with this session | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageSmartAgencies | ||
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 | ||
Return | boolean | false if smart agency management is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getAgentQuery | ||
Description |
Gets an agent query. | ||
Return | osid.authentication.AgentQuery | the agent query | |
Compliance | mandatory | This method must be implemented. | |
Method | getAgentSearchOrder | ||
Description |
Gets an agent search order. | ||
Return | osid.authentication.AgentSearchOrder | the agent search order | |
Compliance | mandatory | This method must be implemented. | |
Method | applyAgentQuery | ||
Description |
Applies an agent query to this agency. | ||
Parameters | osid.authentication.AgentQuery | agentQuery | the agent query |
Errors | NULL_ARGUMENT | agentQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | agentQuery not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | inspectAgentQuery | ||
Description |
Gets an agent query inspector for this agency. | ||
Return | osid.authentication.AgentQueryInspector | the agent query inspector | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | applyAgentSequencing | ||
Description |
Applies an agent search order to this agency. | ||
Parameters | osid.authentication.AgentSearchOrder | agentSearchOrder | the agent search order |
Errors | NULL_ARGUMENT | agentSearchOrder is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | agentSearchOrder not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAgentQueryFromInspector | ||
Description |
Gets an agent query from an inspector. | ||
Parameters | osid.authentication.AgentQueryInspector | agentQueryInspector | a query inspector |
Return | osid.authentication.AgentQuery | the agent query | |
Errors | NULL_ARGUMENT | agentQueryInspector is null | |
UNSUPPORTED | agentQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |