org.osid.authentication.keys

Interface KeyForm

All Superinterfaces:

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

All Known Subinterfaces:

KeyBatchForm

public interface KeyForm
extends OsidObjectForm

This is the form for creating and updating Keys. Various data elements may be set here for use in the create and update methods in the KeyAdminSession. 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
KeyFormRecord	getKeyFormRecord(Type keyRecordType) Gets the KeyFormRecord corresponding to the given key 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

getKeyFormRecord

KeyFormRecord getKeyFormRecord(Type keyRecordType)
                               throws OperationFailedException

Gets the KeyFormRecord corresponding to the given key record Type.

Parameters:

keyRecordType - a key record type

Returns:

the key form record

Throws:

NullArgumentException - keyRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(keyRecordType) is false

Compliance:

mandatory - This method must be implemented.