org.osid.provisioning.batch

Interface RequestTransactionBatchForm

All Superinterfaces:

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

public interface RequestTransactionBatchForm
extends RequestTransactionForm

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

Methods inherited from interface org.osid.provisioning.RequestTransactionForm

clearRequests, getRequestsMetadata, getRequestTransactionFormRecord, setRequests

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 request transaction if this is a create transaction.

Returns:

the broker Id

Throws:

IllegalStateException - isForUpdate() is true

Compliance:

mandatory - This method must be implemented.

getResourceId

Id getResourceId()

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

Returns:

the resource Id

Throws:

IllegalStateException - isForUpdate() is true

Compliance:

mandatory - This method must be implemented.

getRequestId

Id getRequestId()

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

Returns:

the request transaction Id

Throws:

IllegalStateException - isForUpdate() is false

Compliance:

mandatory - This method must be implemented.