org.osid.authorization

Interface VaultForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidCatalogForm, OsidExtensibleForm, OsidFederateableForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidSourceableForm, Suppliable

All Known Subinterfaces:

VaultBatchForm

public interface VaultForm
extends OsidCatalogForm

This is the form for creating and updating vaults. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the VaultAdminSession. 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
VaultFormRecord	getVaultFormRecord(Type vaultRecordType) Gets the VaultFormRecord corresponding to the given vault 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

Methods inherited from interface org.osid.OsidSourceableForm

clearBranding, clearLicense, clearProvider, getBrandingMetadata, getLicenseMetadata, getProviderMetadata, setBranding, setLicense, setProvider

Method Detail

getVaultFormRecord

VaultFormRecord getVaultFormRecord(Type vaultRecordType)
                                   throws OperationFailedException

Gets the VaultFormRecord corresponding to the given vault record Type.

Parameters:

vaultRecordType - a vault record type

Returns:

the vault form record

Throws:

NullArgumentException - vaultRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(vaultRecordType) is false

Compliance:

mandatory - This method must be implemented.