Interface Agent

All Superinterfaces:
Browsable, Extensible, Identifiable, OsidObject
public interface Agent extends OsidObject

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.

Like all OsidObjects, Agent is managed by its OsidSessions and may not be accessed by concurrent processing threads.

  • Method Details

    • getAgentRecord

      AgentRecord getAgentRecord(Type agentRecordType) throws OperationFailedException
      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.
      Parameters:
      agentRecordType - the type of the record to retrieve
      Returns:
      the agent record
      Throws:
      NullArgumentException - agentRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(agentRecordType) is false
      Compliance:
      mandatory - This method must be implemented.