OSID Logo
OSID Specifications
authentication package
Version 3.0.0
Release Candidate Preview
Interfaceosid.authentication.AgentForm
Implementsosid.OsidObjectForm
Description

This is the form for creating and updating Agents. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the AgentAdminSession. For each data element that may be set, metadata may be examined to provide display hints or data constraints.

MethodgetAgentFormRecord
Description

Gets the AgentFormRecord corresponding to the given agent record Type.

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