org.osid.hold.batch

Interface HoldBatchForm

All Superinterfaces:

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

public interface HoldBatchForm
extends HoldForm

This is the form for creating and updating holds in bulk. Like all OsidForm objects, 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.

Method Summary

Methods

Modifier and Type	Method and Description
Id	getAgentId() Gets the agent Id of the issue if this is a create transaction.
Id	getHoldId() Gets the Id of the hold to be updated if this is an update transaction.
Id	getIssueId() Gets the issue Id of the issue if this is a create transaction.
Id	getResourceId() Gets the resource Id of the issue if this is a create transaction.
boolean	hasAgent() Tests if this create form was requested using an agent.
boolean	hasResource() Tests if this create form was requested using a resource.

Methods inherited from interface org.osid.hold.HoldForm

getHoldFormRecord

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

getIssueId

Id getIssueId()

Gets the issue Id of the issue if this is a create transaction.

Returns:

the issue Id

Throws:

IllegalStateException - isForUpdate() is true

Compliance:

mandatory - This method must be implemented.

hasAgent

boolean hasAgent()

Tests if this create form was requested using an agent.

Returns:

true if the create request specified an agent, false otherwise

Throws:

IllegalStateException - isForUpdate() is true

Compliance:

mandatory - This method must be implemented.

getAgentId

Id getAgentId()

Gets the agent Id of the issue if this is a create transaction.

Returns:

the agent Id

Throws:

IllegalStateException - isForUpdate() is true or hasAgent() is false

Compliance:

mandatory - This method must be implemented.

hasResource

boolean hasResource()

Tests if this create form was requested using a resource.

Returns:

true if the create request specified a resource, false otherwise

Throws:

IllegalStateException - isForUpdate() is true

Compliance:

mandatory - This method must be implemented.

getResourceId

Id getResourceId()

Gets the resource Id of the issue if this is a create transaction.

Returns:

the resource Id

Throws:

IllegalStateException - isForUpdate() is true or hasResource() is false

Compliance:

mandatory - This method must be implemented.

getHoldId

Id getHoldId()

Gets the Id of the hold to be updated if this is an update transaction.

Returns:

the hold Id

Throws:

IllegalStateException - isForUpdate() is false

Compliance:

mandatory - This method must be implemented.