OSID Logo
OSID Specifications
authentication package
Version 3.0.0
Release Candidate Preview
Interfaceosid.authentication.Agent
Implementsosid.OsidObject
Description

An Agent represents an authenticatable identity. Like all OSID objects, an Agent is identified by its Id and any persisted references should use the Id.

MethodgetAgentRecord
Description

Gets the agent record corresponding to the given Agent record Type. This method is used to retrieve an object implementing the requested record. The agentRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(agentRecordType) is true .

Parametersosid.type.TypeagentRecordTypethe type of the record to retrieve
Returnosid.authentication.records.AgentRecordthe agent record
ErrorsNULL_ARGUMENT agentRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(agentRecordType) is false
CompliancemandatoryThis method must be implemented.