org.osid.provisioning

Interface PoolForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidGovernatorForm, OsidIdentifiableForm, OsidObjectForm, OsidOperableForm, OsidSourceableForm, OsidSubjugateableForm, Suppliable

All Known Subinterfaces:

PoolBatchForm

public interface PoolForm
extends OsidGovernatorForm, OsidSubjugateableForm

This is the form for creating and updating Pools. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the PoolAdminSession. 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
PoolFormRecord	getPoolFormRecord(Type poolRecordType) Gets the PoolFormRecord corresponding to the given pool record Type.

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.OsidOperableForm

clearDisabled, clearEnabled, getDisabledMetadata, getEnabledMetadata, setDisabled, setEnabled

Methods inherited from interface org.osid.OsidSourceableForm

clearBranding, clearLicense, clearProvider, getBrandingMetadata, getLicenseMetadata, getProviderMetadata, setBranding, setLicense, setProvider

Method Detail

getPoolFormRecord

PoolFormRecord getPoolFormRecord(Type poolRecordType)
                                 throws OperationFailedException

Gets the PoolFormRecord corresponding to the given pool record Type.

Parameters:

poolRecordType - a pool record type

Returns:

the pool form record

Throws:

NullArgumentException - poolRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(poolRecordType) is false

Compliance:

mandatory - This method must be implemented.