org.osid

Interface OsidRuleForm

All Superinterfaces:

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

All Known Subinterfaces:

ActionBatchForm, ActionEnablerForm, ActionEnablerFormRecord, ActionForm, AssessmentEntryBatchForm, AssessmentEntryForm, AssessmentRequirementForm, AuctionConstrainerEnablerForm, AuctionConstrainerEnablerFormRecord, AuctionConstrainerForm, AuctionConstrainerFormRecord, AuctionProcessorEnablerForm, AuctionProcessorEnablerFormRecord, AuctionProcessorForm, AuctionProcessorFormRecord, AuditBatchForm, AuditEnablerForm, AuditEnablerFormRecord, AuthorizationEnablerForm, AuthorizationEnablerFormRecord, AvailabilityEnablerForm, AwardRequirementForm, BallotConstrainerEnablerForm, BallotConstrainerEnablerFormRecord, BallotConstrainerForm, BallotConstrainerFormRecord, BrokerConstrainerEnablerForm, BrokerConstrainerEnablerFormRecord, BrokerConstrainerForm, BrokerConstrainerFormRecord, BrokerProcessorEnablerForm, BrokerProcessorEnablerFormRecord, BrokerProcessorForm, BrokerProcessorFormRecord, CanonicalUnitEnablerForm, CanonicalUnitEnablerFormRecord, CanonicalUnitProcessorEnablerForm, CanonicalUnitProcessorEnablerFormRecord, CanonicalUnitProcessorForm, CanonicalUnitProcessorFormRecord, CatalogEnablerForm, CatalogEnablerFormRecord, CheckForm, CommissionEnablerForm, CommitmentEnablerForm, CommitmentEnablerFormRecord, CompositionEnablerForm, CompositionEnablerFormRecord, ContactEnablerForm, ContactEnablerFormRecord, CourseRequirementForm, CredentialRequirementForm, DemographicEnablerForm, DemographicEnablerFormRecord, DemographicForm, DemographicFormRecord, DeviceEnablerForm, DeviceEnablerFormRecord, EdgeEnablerForm, EdgeEnablerFormRecord, FunctionBatchForm, FunctionForm, GradeSystemTransformForm, HoldEnablerForm, HoldEnablerFormRecord, InputBatchForm, InputEnablerForm, InputEnablerFormRecord, InputForm, InquiryBatchForm, InquiryEnablerForm, InquiryEnablerFormRecord, InquiryForm, InstructionForm, JobConstrainerEnablerForm, JobConstrainerForm, JobProcessorEnablerForm, JobProcessorForm, LearningObjectiveRequirementForm, ObstacleEnablerForm, ObstacleEnablerFormRecord, OfferingConstrainerEnablerForm, OfferingConstrainerEnablerFormRecord, OfferingConstrainerForm, OfferingConstrainerFormRecord, OffsetEventBatchForm, OffsetEventEnablerForm, OffsetEventEnablerFormRecord, OffsetEventForm, OsidConstrainerForm, OsidEnablerForm, OsidProcessorForm, ParameterBatchForm, ParameterForm, ParameterProcessorEnablerForm, ParameterProcessorEnablerFormRecord, ParameterProcessorForm, ParameterProcessorFormRecord, PoolConstrainerEnablerForm, PoolConstrainerEnablerFormRecord, PoolConstrainerForm, PoolConstrainerFormRecord, PoolProcessorEnablerForm, PoolProcessorEnablerFormRecord, PoolProcessorForm, PoolProcessorFormRecord, PriceEnablerForm, PriceEnablerFormRecord, PriceForm, ProcessEnablerForm, ProcessEnablerFormRecord, ProfileEntryEnablerForm, ProfileEntryEnablerFormRecord, ProgramRequirementForm, QueueConstrainerEnablerForm, QueueConstrainerEnablerForm, QueueConstrainerEnablerFormRecord, QueueConstrainerEnablerFormRecord, QueueConstrainerForm, QueueConstrainerForm, QueueConstrainerFormRecord, QueueConstrainerFormRecord, QueueProcessorEnablerForm, QueueProcessorEnablerForm, QueueProcessorEnablerFormRecord, QueueProcessorEnablerFormRecord, QueueProcessorForm, QueueProcessorForm, QueueProcessorFormRecord, QueueProcessorFormRecord, RaceConstrainerEnablerForm, RaceConstrainerEnablerFormRecord, RaceConstrainerForm, RaceConstrainerFormRecord, RaceProcessorEnablerForm, RaceProcessorEnablerFormRecord, RaceProcessorForm, RaceProcessorFormRecord, RecurringEventBatchForm, RecurringEventEnablerForm, RecurringEventEnablerFormRecord, RecurringEventForm, RelationshipEnablerForm, RelationshipEnablerFormRecord, RelevancyEnablerForm, RelevancyEnablerFormRecord, RequisiteForm, SequenceRuleEnablerForm, SequenceRuleEnablerFormRecord, SequenceRuleForm, SignalBatchForm, SignalEnablerForm, SignalEnablerFormRecord, SignalForm, SpeedZoneBatchForm, SpeedZoneEnablerForm, SpeedZoneEnablerFormRecord, SpeedZoneForm, StepConstrainerEnablerForm, StepConstrainerEnablerFormRecord, StepConstrainerForm, StepConstrainerFormRecord, StepProcessorEnablerForm, StepProcessorEnablerFormRecord, StepProcessorForm, StepProcessorFormRecord, SubscriptionEnablerForm, SubscriptionEnablerFormRecord, SupersedingEventEnablerForm, SupersedingEventEnablerFormRecord, SupersedingEventForm, TodoProducerForm, TodoProducerFormRecord, TriggerBatchForm, TriggerEnablerForm, TriggerEnablerFormRecord, TriggerForm, ValueEnablerForm, ValueEnablerFormRecord

public interface OsidRuleForm
extends OsidObjectForm, OsidOperableForm

This form is used to create and update rules.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearRule() Removes the rule.
Metadata	getRuleMetadata() Gets the metadata for an associated rule.
void	setRule(Id ruleId) Sets a rule.

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

getRuleMetadata

Metadata getRuleMetadata()

Gets the metadata for an associated rule.

Returns:

metadata for the rule

Compliance:

mandatory - This method must be implemented.

setRule

void setRule(Id ruleId)

Sets a rule.

Parameters:

ruleId - the new rule

Throws:

InvalidArgumentException - ruleId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - ruleId is null

Compliance:

mandatory - This method must be implemented.

clearRule

void clearRule()

Removes the rule.

Throws:

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

Compliance:

mandatory - This method must be implemented.