Interface OsidOperableForm

All Superinterfaces:
Identifiable, OsidForm, Suppliable
All Known Subinterfaces:
ActionBatchForm, ActionEnablerForm, ActionForm, ActivityUnitBatchForm, ActivityUnitForm, AgendaForm, AssessmentEntryBatchForm, AssessmentEntryForm, AssessmentPartForm, AssessmentRequirementForm, AuctionBatchForm, AuctionConstrainerEnablerForm, AuctionConstrainerForm, AuctionForm, AuctionProcessorEnablerForm, AuctionProcessorForm, AuditBatchForm, AuditConstrainerEnablerForm, AuditConstrainerForm, AuditEnablerForm, AuditForm, AuditProcessorEnablerForm, AuditProcessorForm, AuthorizationEnablerForm, AvailabilityEnablerForm, AwardRequirementForm, BallotBatchForm, BallotConstrainerEnablerForm, BallotConstrainerEnablerFormRecord, BallotConstrainerForm, BallotConstrainerFormRecord, BallotForm, BidEnablerForm, BranchBatchForm, BranchForm, BrokerBatchForm, BrokerConstrainerEnablerForm, BrokerConstrainerForm, BrokerEnablerForm, BrokerForm, BrokerProcessorEnablerForm, BrokerProcessorForm, CanonicalUnitBatchForm, CanonicalUnitEnablerForm, CanonicalUnitForm, CanonicalUnitProcessorEnablerForm, CanonicalUnitProcessorForm, CatalogEnablerForm, CheckForm, CommissionEnablerForm, CommitmentEnablerForm, CompositionBatchForm, CompositionEnablerForm, CompositionForm, ContactEnablerForm, ControllerBatchForm, ControllerForm, ConvocationBatchForm, ConvocationForm, CourseBatchForm, CourseForm, CourseRequirementForm, CredentialRequirementForm, DemographicEnablerForm, DemographicForm, DeviceEnablerForm, DispatchBatchForm, DispatchConstrainerEnablerForm, DispatchConstrainerForm, DispatchEnablerForm, DispatchForm, DispatchProcessorEnablerForm, DispatchProcessorForm, EdgeEnablerForm, FunctionBatchForm, FunctionForm, GradeSystemTransformForm, HoldEnablerForm, InputBatchForm, InputEnablerForm, InputForm, InquiryBatchForm, InquiryEnablerForm, InquiryForm, InstructionForm, IssueBatchForm, IssueConstrainerEnablerForm, IssueConstrainerForm, IssueEnablerForm, IssueForm, IssueProcessorEnablerForm, IssueProcessorForm, JobBatchForm, JobConstrainerEnablerForm, JobConstrainerForm, JobForm, JobProcessorEnablerForm, JobProcessorForm, LearningObjectiveRequirementForm, ObstacleBatchForm, ObstacleEnablerForm, ObstacleForm, OfferingConstrainerEnablerForm, OffsetEventBatchForm, OffsetEventEnablerForm, OffsetEventForm, OsidConstrainerForm, OsidEffectuatorForm, OsidEnablerForm, OsidGovernatorForm, OsidOperatorForm, OsidProcessorForm, OsidRuleApplicatorForm, OsidRuleForm, ParameterBatchForm, ParameterForm, ParameterProcessorEnablerForm, ParameterProcessorForm, PoolBatchForm, PoolConstrainerEnablerForm, PoolConstrainerForm, PoolEnablerForm, PoolForm, PoolProcessorEnablerForm, PoolProcessorForm, PriceEnablerForm, PriceForm, ProcessBatchForm, ProcessConstrainerEnablerForm, ProcessConstrainerForm, ProcessEnablerForm, ProcessForm, ProcessProcessorEnablerForm, ProcessProcessorForm, ProfileEntryEnablerForm, ProgramBatchForm, ProgramForm, ProgramRequirementForm, ProvisionableEnablerForm, ProvisionEnablerForm, QueueBatchForm, QueueBatchForm, QueueConstrainerEnablerForm, QueueConstrainerEnablerForm, QueueConstrainerForm, QueueConstrainerForm, QueueEnablerForm, QueueEnablerForm, QueueForm, QueueForm, QueueProcessorEnablerForm, QueueProcessorEnablerForm, QueueProcessorForm, QueueProcessorForm, RaceBatchForm, RaceConstrainerEnablerForm, RaceConstrainerEnablerFormRecord, RaceConstrainerForm, RaceConstrainerFormRecord, RaceForm, 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, ValueBatchForm, ValueEnablerForm, ValueForm, VoteEnablerForm
public interface OsidOperableForm extends OsidForm

This form is used to create and update operables.

  • Method Details

    • getEnabledMetadata

      Metadata getEnabledMetadata()
      Gets the metadata for the enabled flag.
      Returns:
      metadata for the enabled flag
      Compliance:
      mandatory - This method must be implemented.

    • setEnabled

      void setEnabled(boolean enabled)
      Sets the administratively enabled flag.
      Parameters:
      enabled - the new enabled flag
      Throws:
      InvalidArgumentException - enabled is invalid
      NoAccessException - Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • clearEnabled

      void clearEnabled()
      Removes the administratively enabled flag.
      Throws:
      NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getDisabledMetadata

      Metadata getDisabledMetadata()
      Gets the metadata for the disabled flag.
      Returns:
      metadata for the disabled flag
      Compliance:
      mandatory - This method must be implemented.

    • setDisabled

      void setDisabled(boolean disabled)
      Sets the administratively disabled flag.
      Parameters:
      disabled - the new disabled flag
      Throws:
      InvalidArgumentException - disabled is invalid
      NoAccessException - Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • clearDisabled

      void clearDisabled()
      Removes the administratively disabled flag.
      Throws:
      NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.