Interface HoldBatchForm
- All Superinterfaces:
Extensible, HoldForm, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidRelationshipForm, OsidTemporalForm, Suppliable
This is the form for creating and updating holds in bulk. Like all
OsidForms, various data elements may be set here for use in the
create and update methods in the HoldBatchAdminSession. For each
data element that may be set, metadata may be examined to provide display
hints or data constraints.
Like all OsidForms, HoldBatchForm is stateful and must
not be accessed by multiple processing threads.
-
Method Summary
Modifier and TypeMethodDescriptionGets theIdof the hold to be updated if this is an update transaction.Gets the issueIdof the issue if this is a create transaction.Gets the resourceIdof the hold if this is a create transaction.Methods inherited from interface Extensible
getRecordTypes, hasRecordTypeMethods inherited from interface HoldForm
getHoldFormRecordMethods inherited from interface Identifiable
getId, isCurrentMethods inherited from interface OsidExtensibleForm
getRequiredRecordTypesMethods inherited from interface OsidForm
getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocaleMethods inherited from interface OsidObjectForm
clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusTypeMethods inherited from interface OsidRelationshipForm
clearEndReason, getEndReasonMetadata, setEndReasonMethods inherited from interface OsidTemporalForm
clearEndDate, clearStartDate, getEndDateMetadata, getStartDateMetadata, setEndDate, setStartDate
-
Method Details
-
getIssueId
Id getIssueId()Gets the issueIdof the issue if this is a create transaction.- Returns:
- the issue
Id - Throws:
IllegalStateException-isForUpdate()istrue- Compliance:
mandatory- This method must be implemented.
-
getResourceId
Id getResourceId()Gets the resourceIdof the hold if this is a create transaction.- Returns:
- the resource
Id - Throws:
IllegalStateException-isForUpdate()istrue- Compliance:
mandatory- This method must be implemented.
-
getHoldId
Id getHoldId()Gets theIdof the hold to be updated if this is an update transaction.- Returns:
- the hold
Id - Throws:
IllegalStateException-isForUpdate()isfalse- Compliance:
mandatory- This method must be implemented.
-