org.osid.hold

Interface HoldForm

All Superinterfaces:

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

All Known Subinterfaces:

HoldBatchForm

public interface HoldForm
extends OsidRelationshipForm

This is the form for creating and updating Holds. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the HoldAdminSession. 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
HoldFormRecord	getHoldFormRecord(Type holdRecordType) Gets the HoldFormRecord corresponding to the given hold 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

getHoldFormRecord

HoldFormRecord getHoldFormRecord(Type holdRecordType)
                                 throws OperationFailedException,
                                        PermissionDeniedException

Gets the HoldFormRecord corresponding to the given hold record Type.

Parameters:

holdRecordType - a hold record type

Returns:

the hold form record

Throws:

NullArgumentException - holdRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(holdRecordType) is false

Compliance:

mandatory - This method must be implemented.