org.osid.provisioning.batch

Interface ProvisionableBatchForm

All Superinterfaces:

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

public interface ProvisionableBatchForm
extends ProvisionableForm

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

Methods inherited from interface org.osid.provisioning.ProvisionableForm

getProvisionableFormRecord

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

getResourceId

Id getResourceId()

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

Returns:

the resource Id

Throws:

IllegalStateException - isForUpdate() is true

Compliance:

mandatory - This method must be implemented.

getPoolId

Id getPoolId()

Gets the Pool Id of the provisionable if this is a create transaction.

Returns:

the pool Id

Throws:

IllegalStateException - isForUpdate() is true

Compliance:

mandatory - This method must be implemented.

getProvisionableId

Id getProvisionableId()

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

Returns:

the provisionable Id

Throws:

IllegalStateException - isForUpdate() is false

Compliance:

mandatory - This method must be implemented.