org.osid.provisioning.batch

Interface ProvisionBatchForm

All Superinterfaces:

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

public interface ProvisionBatchForm
extends ProvisionForm

This is the form for creating and updating provisions in bulk. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the ProvisionBatchAdminSession. 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	getBrokerId() Gets the Broker Id of the provision if this is a create transaction.
Id	getProvisionableId() Gets the Provisionable Id of the provision if this is a create transaction.
Id	getProvisionId() Gets the Id of the provision to be updated if this is an update transaction.
Id	getResourceId() Gets the Resource Id of the provision if this is a create transaction.

Methods inherited from interface org.osid.provisioning.ProvisionForm

clearCost, clearDueDate, clearRateAmount, clearRatePeriod, clearRequest, getCostMetadata, getDueDateMetadata, getProvisionFormRecord, getRateAmountMetadata, getRatePeriodMetadata, getRequestMetadata, setCost, setDueDate, setRateAmount, setRatePeriod, setRequest

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

getBrokerId

Id getBrokerId()

Gets the Broker Id of the provision if this is a create transaction.

Returns:

the broker Id

Throws:

IllegalStateException - isForUpdate() is true

Compliance:

mandatory - This method must be implemented.

getProvisionableId

Id getProvisionableId()

Gets the Provisionable Id of the provision if this is a create transaction.

Returns:

the provisionable Id

Throws:

IllegalStateException - isForUpdate() is true

Compliance:

mandatory - This method must be implemented.

getResourceId

Id getResourceId()

Gets the Resource Id of the provision if this is a create transaction.

Returns:

the resource Id

Throws:

IllegalStateException - isForUpdate() is true

Compliance:

mandatory - This method must be implemented.

getProvisionId

Id getProvisionId()

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

Returns:

the provision Id

Throws:

IllegalStateException - isForUpdate() is false

Compliance:

mandatory - This method must be implemented.