OSID Logo
OSID Specifications
resource package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resource.ResourceAgentSession
Implementsosid.OsidSession
Description

This session provides methods to retrieve Resource to Agent mappings. An Agent may map to only one Resource while a Resource may map to multiple Agents.

This lookup session defines several views

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition
MethodgetBinId
Description

Gets the Bin Id associated with this session.

Returnosid.id.Idthe Bin Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetBin
Description

Gets the Bin associated with this session.

Returnosid.resource.Binthe Bin associated with this session
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanLookupResourceAgentMappings
Description

Tests if this user can perform lookups of resource/agent mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 lookup operations to unauthorized users.

Returnboolean false if looking up mappings is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeAgentView
Description

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryAgentView
Description

A complete view of the Agent returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

CompliancemandatoryThis method is must be implemented.
MethoduseFederatedBinView
Description

Federates the view for methods in this session. A federated view will include resources in bins which are children of this bin in the bin hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedBinView
Description

Isolates the view for methods in this session. An isolated view restricts lookups to this bin only.

CompliancemandatoryThis method is must be implemented.
MethodgetResourceIdByAgent
Description

Gets the Resource Id associated with the given agent.

Parametersosid.id.IdagentId Id of the Agent
Returnosid.id.Idassociated resource
ErrorsNOT_FOUND agentId is not found
NULL_ARGUMENT agentId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetResourceByAgent
Description

Gets the Resource associated with the given agent.

Parametersosid.id.IdagentId Id of the Agent
Returnosid.resource.Resourceassociated resource
ErrorsNOT_FOUND agentId is not found
NULL_ARGUMENT agentId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAgentIdsByResource
Description

Gets the list of Agent Ids mapped to a Resource.

Parametersosid.id.IdresourceId Id of a Resource
Returnosid.id.IdListlist of agent Ids
ErrorsNOT_FOUND resourceId is not found
NULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAgentsByResource
Description

Gets the list of Agents mapped to a Resource.

Parametersosid.id.IdresourceId Id of a Resource
Returnosid.authentication.AgentListlist of agents
ErrorsNOT_FOUND resourceId is not found
NULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.