org.osid.provisioning

Interface ProvisionReturnForm

All Superinterfaces:

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

public interface ProvisionReturnForm
extends OsidObjectForm, OsidSubjugateableForm

This is the form for creating and updating ProvisionReturns. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the ProvisionReturnSession. 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
ProvisionReturnFormRecord	getProvisionReturnFormRecord(Type provisionReturnRecordType) Gets the ProvisionReturnFormRecord corresponding to the given provision 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

getProvisionReturnFormRecord

ProvisionReturnFormRecord getProvisionReturnFormRecord(Type provisionReturnRecordType)
                                                       throws OperationFailedException

Gets the ProvisionReturnFormRecord corresponding to the given provision record Type.

Parameters:

provisionReturnRecordType - a provision return record type

Returns:

the provision return form record

Throws:

NullArgumentException - provisionReturnRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(provisionReturnRecordType) is false

Compliance:

mandatory - This method must be implemented.