org.osid.provisioning

Interface RequestTransactionForm

All Superinterfaces:

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

All Known Subinterfaces:

RequestTransactionBatchForm

public interface RequestTransactionForm
extends OsidRelationshipForm

This is the form for creating and updating RequestTransactionss. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the RequestTransactionAdminSession. 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
void	clearRequests() Removes the requests.
Metadata	getRequestsMetadata() Gets the metadata for the requests.
RequestTransactionFormRecord	getRequestTransactionFormRecord(Type requestTransactionRecordType) Gets the RequestTransactionFormRecord corresponding to the given request record Type.
void	setRequests(Id requestIds) Sets the requests.

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

getRequestsMetadata

Metadata getRequestsMetadata()

Gets the metadata for the requests.

Returns:

metadata for the requests

Compliance:

mandatory - This method must be implemented.

setRequests

void setRequests(Id requestIds)

Sets the requests.

Parameters:

requestIds - the new requests

Throws:

InvalidArgumentException - requestIds is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - requestIds is null

Compliance:

mandatory - This method must be implemented.

clearRequests

void clearRequests()

Removes the requests.

Throws:

NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getRequestTransactionFormRecord

RequestTransactionFormRecord getRequestTransactionFormRecord(Type requestTransactionRecordType)
                                                             throws OperationFailedException

Gets the RequestTransactionFormRecord corresponding to the given request record Type.

Parameters:

requestTransactionRecordType - a request transaction record type

Returns:

the request transaction form record

Throws:

NullArgumentException - requestTransactionRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(requestTransactionRecordType) is false

Compliance:

mandatory - This method must be implemented.