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.
Modifier and Type | Method and Description |
---|---|
ProvisionReturnFormRecord |
getProvisionReturnFormRecord(Type provisionReturnRecordType)
Gets the
ProvisionReturnFormRecord corresponding to the
given provision record Type. |
clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType
getRequiredRecordTypes
getRecordTypes, hasRecordType
getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale
getId, isCurrent
ProvisionReturnFormRecord getProvisionReturnFormRecord(Type provisionReturnRecordType) throws OperationFailedException
ProvisionReturnFormRecord
corresponding to the
given provision record Type.
provisionReturnRecordType
- a provision return record typeNullArgumentException
-
provisionReturnRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(provisionReturnRecordType)
is
false
mandatory
- This method must be implemented.