org.osid.authentication

Interface AgentForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, Suppliable

public interface AgentForm
extends OsidObjectForm

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.

Method Summary

Methods

Modifier and Type	Method and Description
AgentFormRecord	getAgentFormRecord(Type agentRecordType) Gets the AgentFormRecord corresponding to the given agent record Type.

Methods inherited from interface org.osid.OsidObjectForm

clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType

Methods inherited from interface org.osid.OsidExtensibleForm

getRequiredRecordTypes

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidForm

getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Method Detail

getAgentFormRecord

AgentFormRecord getAgentFormRecord(Type agentRecordType)
                                   throws OperationFailedException

Gets the AgentFormRecord corresponding to the given agent record Type.

Parameters:

agentRecordType - the agent record type

Returns:

the agent form record

Throws:

NullArgumentException - agentRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(agentRecordType) is false

Compliance:

mandatory - This method must be implemented.