org.osid.provisioning

Interface ProvisionableForm

All Superinterfaces:

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

All Known Subinterfaces:

ProvisionableBatchForm

public interface ProvisionableForm
extends OsidRelationshipForm

This is the form for creating and updating provisionables. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the ProvisionableAdminSession. 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
ProvisionableFormRecord	getProvisionableFormRecord(Type provisionableRecordType) Gets the ProvisionableFormRecord corresponding to the given provisionable 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.OsidTemporalForm

clearEndDate, clearStartDate, getEndDateMetadata, getStartDateMetadata, setEndDate, setStartDate

Method Detail

getProvisionableFormRecord

ProvisionableFormRecord getProvisionableFormRecord(Type provisionableRecordType)
                                                   throws OperationFailedException

Gets the ProvisionableFormRecord corresponding to the given provisionable record Type.

Parameters:

provisionableRecordType - a provisionable record type

Returns:

the provisionable form record

Throws:

NullArgumentException - provisionableRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(provisionableRecordType) is false

Compliance:

mandatory - This method must be implemented.