org.osid.provisioning.rules

Interface PoolProcessorEnablerForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidEnablerForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidOperableForm, OsidRuleForm, OsidTemporalForm, Suppliable

public interface PoolProcessorEnablerForm
extends OsidEnablerForm

This is the form for creating and updating PoolProcessorEnablers. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the PoolProcessorEnablerAdminSession. 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
PoolProcessorEnablerFormRecord	getPoolProcessorEnablerFormRecord(Type poolProcessorEnablerRecordType) Gets the PoolProcessorEnablerFormRecord corresponding to the given pool processor enabler record Type.

Methods inherited from interface org.osid.OsidEnablerForm

clearCyclicEvent, clearDemographic, clearEvent, clearSchedule, getCyclicEventMetadata, getDemographicMetadata, getEventMetadata, getScheduleMetadata, setCyclicEvent, setDemographic, setEvent, setSchedule

Methods inherited from interface org.osid.OsidRuleForm

clearRule, getRuleMetadata, setRule

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

clearEndDate, clearStartDate, getEndDateMetadata, getStartDateMetadata, setEndDate, setStartDate

Method Detail

getPoolProcessorEnablerFormRecord

PoolProcessorEnablerFormRecord getPoolProcessorEnablerFormRecord(Type poolProcessorEnablerRecordType)
                                                                 throws OperationFailedException

Gets the PoolProcessorEnablerFormRecord corresponding to the given pool processor enabler record Type.

Parameters:

poolProcessorEnablerRecordType - a pool processor enabler record type

Returns:

the pool processor enabler form record

Throws:

NullArgumentException - poolProcessorEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(poolProcessorEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.