org.osid.provisioning.rules

Interface BrokerConstrainerForm

All Superinterfaces:

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

public interface BrokerConstrainerForm
extends OsidConstrainerForm

This is the form for creating and updating BrokerConstrainers. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the BrokerConstrainerAdminSession. 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
BrokerConstrainerFormRecord	getBrokerConstrainerFormRecord(Type brokerConstrainerRecordType) Gets the BrokerConstrainerFormRecord corresponding to the given broker constrainer 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

getBrokerConstrainerFormRecord

BrokerConstrainerFormRecord getBrokerConstrainerFormRecord(Type brokerConstrainerRecordType)
                                                           throws OperationFailedException

Gets the BrokerConstrainerFormRecord corresponding to the given broker constrainer record Type.

Parameters:

brokerConstrainerRecordType - a broker constrainer record type

Returns:

the broker constrainer form record

Throws:

NullArgumentException - brokerConstrainerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(brokerConstrainerRecordType) is false

Compliance:

mandatory - This method must be implemented.