org.osid.offering.rules

Interface CanonicalUnitProcessorForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidOperableForm, OsidProcessorForm, OsidRuleForm, Suppliable

public interface CanonicalUnitProcessorForm
extends OsidProcessorForm

This is the form for creating and updating CanonicalUnitProcessors. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the CanonicalUnitProcessorAdminSession. 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
CanonicalUnitProcessorFormRecord	getCanonicalUnitProcessorFormRecord(Type canonicalUnitProcessorRecordType) Gets the CanonicalUnitProcessorFormRecord corresponding to the given canonical unit processor record Type.

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

Method Detail

getCanonicalUnitProcessorFormRecord

CanonicalUnitProcessorFormRecord getCanonicalUnitProcessorFormRecord(Type canonicalUnitProcessorRecordType)
                                                                     throws OperationFailedException

Gets the CanonicalUnitProcessorFormRecord corresponding to the given canonical unit processor record Type.

Parameters:

canonicalUnitProcessorRecordType - a canonical unit processor record type

Returns:

the canonical unit processor form record

Throws:

NullArgumentException - canonicalUnitProcessorRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(canonicalUnitProcessorRecordType) is false

Compliance:

mandatory - This method must be implemented.