Interface OsidRuleForm

All Superinterfaces:
Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidOperableForm, Suppliable
All Known Subinterfaces:
ActionBatchForm, ActionEnablerForm, ActionForm, AgendaForm, AssessmentEntryBatchForm, AssessmentEntryForm, AssessmentRequirementForm, AuctionConstrainerEnablerForm, AuctionConstrainerForm, AuctionProcessorEnablerForm, AuctionProcessorForm, AuditBatchForm, AuditConstrainerEnablerForm, AuditConstrainerForm, AuditEnablerForm, AuditProcessorEnablerForm, AuditProcessorForm, AuthorizationEnablerForm, AvailabilityEnablerForm, AwardRequirementForm, BallotConstrainerEnablerForm, BallotConstrainerEnablerFormRecord, BallotConstrainerForm, BallotConstrainerFormRecord, BidEnablerForm, BrokerConstrainerEnablerForm, BrokerConstrainerForm, BrokerEnablerForm, BrokerProcessorEnablerForm, BrokerProcessorForm, CanonicalUnitEnablerForm, CanonicalUnitProcessorEnablerForm, CanonicalUnitProcessorForm, CatalogEnablerForm, CheckForm, CommissionEnablerForm, CommitmentEnablerForm, CompositionEnablerForm, ContactEnablerForm, CourseRequirementForm, CredentialRequirementForm, DemographicEnablerForm, DemographicForm, DeviceEnablerForm, DispatchConstrainerEnablerForm, DispatchConstrainerForm, DispatchEnablerForm, DispatchProcessorEnablerForm, DispatchProcessorForm, EdgeEnablerForm, FunctionBatchForm, FunctionForm, GradeSystemTransformForm, HoldEnablerForm, InputBatchForm, InputEnablerForm, InputForm, InquiryBatchForm, InquiryEnablerForm, InquiryForm, InstructionForm, IssueConstrainerEnablerForm, IssueConstrainerForm, IssueEnablerForm, IssueProcessorEnablerForm, IssueProcessorForm, JobConstrainerEnablerForm, JobConstrainerForm, JobProcessorEnablerForm, JobProcessorForm, LearningObjectiveRequirementForm, ObstacleEnablerForm, OfferingConstrainerEnablerForm, OffsetEventBatchForm, OffsetEventEnablerForm, OffsetEventForm, OsidConstrainerForm, OsidEffectuatorForm, OsidEnablerForm, OsidOperatorForm, OsidProcessorForm, OsidRuleApplicatorForm, ParameterBatchForm, ParameterForm, ParameterProcessorEnablerForm, ParameterProcessorForm, PoolConstrainerEnablerForm, PoolConstrainerForm, PoolEnablerForm, PoolProcessorEnablerForm, PoolProcessorForm, PriceEnablerForm, PriceForm, ProcessConstrainerEnablerForm, ProcessConstrainerForm, ProcessEnablerForm, ProcessProcessorEnablerForm, ProcessProcessorForm, ProfileEntryEnablerForm, ProgramRequirementForm, ProvisionableEnablerForm, ProvisionEnablerForm, QueueConstrainerEnablerForm, QueueConstrainerEnablerForm, QueueConstrainerForm, QueueConstrainerForm, QueueEnablerForm, QueueEnablerForm, QueueProcessorEnablerForm, QueueProcessorEnablerForm, QueueProcessorForm, QueueProcessorForm, RaceConstrainerEnablerForm, RaceConstrainerEnablerFormRecord, RaceConstrainerForm, RaceConstrainerFormRecord, RaceProcessorEnablerForm, RaceProcessorEnablerFormRecord, RaceProcessorForm, RaceProcessorFormRecord, RecurringEventBatchForm, RecurringEventEnablerForm, RecurringEventForm, RelationshipEnablerForm, RequisiteForm, SequenceRuleEnablerForm, SequenceRuleForm, SignalBatchForm, SignalEnablerForm, SignalForm, SpeedZoneBatchForm, SpeedZoneEnablerForm, SpeedZoneForm, StepBatchForm, StepConstrainerEnablerForm, StepConstrainerForm, StepEnablerForm, StepForm, StepProcessorEnablerForm, StepProcessorForm, SubscriptionEnablerForm, SupersedingEventEnablerForm, SupersedingEventForm, TodoProducerForm, TriggerBatchForm, TriggerEnablerForm, TriggerForm, ValueEnablerForm, VoteEnablerForm
public interface OsidRuleForm extends OsidObjectForm, OsidOperableForm

This form is used to create and update rules.

  • Method Details

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

    • getConditionRecordTypesMetadata

      Metadata getConditionRecordTypesMetadata()
      Gets the metadata for the condition record types.
      Returns:
      metadata for the condition record types
      Compliance:
      mandatory - This method must be implemented.

    • setConditionRecordTypes

      void setConditionRecordTypes(Type[] conditionRecordTypes)
      Sets the condition record types.
      Parameters:
      conditionRecordTypes - the new condition record types
      Throws:
      InvalidArgumentException - conditionRecordTypes is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - conditionRecordTypes is null
      Compliance:
      mandatory - This method must be implemented.

    • clearConditionRecordTypes

      void clearConditionRecordTypes()
      Clears the condition record types.
      Throws:
      NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.