org.osid.repository

Interface RepositoryForm

All Superinterfaces:

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

All Known Subinterfaces:

RepositoryBatchForm

public interface RepositoryForm
extends OsidCatalogForm

This is the form for creating and updating repositories. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the RepositoryAdminSession. 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
RepositoryFormRecord	getRepositoryFormRecord(Type repositoryRecordType) Gets the RepositoryFormRecord corresponding to the given repository 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

getRepositoryFormRecord

RepositoryFormRecord getRepositoryFormRecord(Type repositoryRecordType)
                                             throws OperationFailedException

Gets the RepositoryFormRecord corresponding to the given repository record Type.

Parameters:

repositoryRecordType - a repository record type

Returns:

the repository form record

Throws:

NullArgumentException - repositoryRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(repositoryRecordType) is false

Compliance:

mandatory - This method must be implemented.