org.osid.offering.batch

Interface OfferingBatchForm

All Superinterfaces:

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

public interface OfferingBatchForm
extends OfferingForm

This is the form for creating and updating offerings in bulk. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the OfferingBatchAdminSession. 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	getCanonicalUnitId() Gets the Id of the canonical unit if this is a create transaction.
Id	getOfferingId() Gets the Id of the offering to be updated if this is an update transaction.
Id	getTimePeriodId() Gets the Id of the time period if this is a create transaction.

Methods inherited from interface org.osid.offering.OfferingForm

clearCode, clearResultOptions, clearSponsors, clearTitle, getCodeMetadata, getOfferingFormRecord, getResultOptionsMetadata, getSponsorsMetadata, getTitleMetadata, setCode, setResultOptions, setSponsors, setTitle

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

getCanonicalUnitId

Id getCanonicalUnitId()

Gets the Id of the canonical unit if this is a create transaction.

Returns:

the canonical unit Id

Throws:

IllegalStateException - isForUpdate() is true

Compliance:

mandatory - This method must be implemented.

getTimePeriodId

Id getTimePeriodId()

Gets the Id of the time period if this is a create transaction.

Returns:

the time period Id

Throws:

IllegalStateException - isForUpdate() is true

Compliance:

mandatory - This method must be implemented.

getOfferingId

Id getOfferingId()

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

Returns:

the offering Id

Throws:

IllegalStateException - isForUpdate() is false

Compliance:

mandatory - This method must be implemented.