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.
Modifier and Type | Method and Description |
---|---|
AgentRecord |
getAgentRecord(Type agentRecordType)
Gets the agent record corresponding to the given
Agent
record Type. |
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
AgentRecord getAgentRecord(Type agentRecordType) throws OperationFailedException
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
.agentRecordType
- the type of the record to retrieveNullArgumentException
- agentRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(agentRecordType)
is false
mandatory
- This method must be implemented.