org.osid

Interface OsidOperableForm

All Superinterfaces:

Identifiable, OsidForm, Suppliable

All Known Subinterfaces:

ActionBatchForm, ActionEnablerForm, ActionEnablerFormRecord, ActionForm, ActivityUnitBatchForm, ActivityUnitForm, AssessmentEntryBatchForm, AssessmentEntryForm, AssessmentPartForm, AssessmentRequirementForm, AuctionBatchForm, AuctionConstrainerEnablerForm, AuctionConstrainerEnablerFormRecord, AuctionConstrainerForm, AuctionConstrainerFormRecord, AuctionForm, AuctionProcessorEnablerForm, AuctionProcessorEnablerFormRecord, AuctionProcessorForm, AuctionProcessorFormRecord, AuditBatchForm, AuditEnablerForm, AuditEnablerFormRecord, AuditForm, AuthorizationEnablerForm, AuthorizationEnablerFormRecord, AvailabilityEnablerForm, AwardRequirementForm, BallotBatchForm, BallotConstrainerEnablerForm, BallotConstrainerEnablerFormRecord, BallotConstrainerForm, BallotConstrainerFormRecord, BallotForm, BranchBatchForm, BranchForm, BrokerBatchForm, BrokerConstrainerEnablerForm, BrokerConstrainerEnablerFormRecord, BrokerConstrainerForm, BrokerConstrainerFormRecord, BrokerForm, BrokerProcessorEnablerForm, BrokerProcessorEnablerFormRecord, BrokerProcessorForm, BrokerProcessorFormRecord, CanonicalUnitBatchForm, CanonicalUnitEnablerForm, CanonicalUnitEnablerFormRecord, CanonicalUnitForm, CanonicalUnitProcessorEnablerForm, CanonicalUnitProcessorEnablerFormRecord, CanonicalUnitProcessorForm, CanonicalUnitProcessorFormRecord, CatalogEnablerForm, CatalogEnablerFormRecord, CheckForm, CommissionEnablerForm, CommitmentEnablerForm, CommitmentEnablerFormRecord, CompositionBatchForm, CompositionEnablerForm, CompositionEnablerFormRecord, CompositionForm, ContactEnablerForm, ContactEnablerFormRecord, ControllerBatchForm, ControllerForm, ConvocationBatchForm, ConvocationForm, CourseBatchForm, CourseForm, CourseRequirementForm, CredentialRequirementForm, DemographicEnablerForm, DemographicEnablerFormRecord, DemographicForm, DemographicFormRecord, DeviceEnablerForm, DeviceEnablerFormRecord, DispatchBatchForm, DispatchForm, EdgeEnablerForm, EdgeEnablerFormRecord, FunctionBatchForm, FunctionForm, GradeSystemTransformForm, HoldEnablerForm, HoldEnablerFormRecord, InputBatchForm, InputEnablerForm, InputEnablerFormRecord, InputForm, InquiryBatchForm, InquiryEnablerForm, InquiryEnablerFormRecord, InquiryForm, InstructionForm, JobBatchForm, JobConstrainerEnablerForm, JobConstrainerForm, JobForm, JobProcessorEnablerForm, JobProcessorForm, LearningObjectiveRequirementForm, ModuleBatchForm, ModuleForm, ObstacleBatchForm, ObstacleEnablerForm, ObstacleEnablerFormRecord, ObstacleForm, OfferingConstrainerEnablerForm, OfferingConstrainerEnablerFormRecord, OfferingConstrainerForm, OfferingConstrainerFormRecord, OffsetEventBatchForm, OffsetEventEnablerForm, OffsetEventEnablerFormRecord, OffsetEventForm, OsidConstrainerForm, OsidEnablerForm, OsidGovernatorForm, OsidProcessorForm, OsidRuleForm, ParameterBatchForm, ParameterForm, ParameterProcessorEnablerForm, ParameterProcessorEnablerFormRecord, ParameterProcessorForm, ParameterProcessorFormRecord, PoolBatchForm, PoolConstrainerEnablerForm, PoolConstrainerEnablerFormRecord, PoolConstrainerForm, PoolConstrainerFormRecord, PoolForm, PoolProcessorEnablerForm, PoolProcessorEnablerFormRecord, PoolProcessorForm, PoolProcessorFormRecord, PriceEnablerForm, PriceEnablerFormRecord, PriceForm, ProcessBatchForm, ProcessEnablerForm, ProcessEnablerFormRecord, ProcessForm, ProfileEntryEnablerForm, ProfileEntryEnablerFormRecord, ProgramBatchForm, ProgramForm, ProgramRequirementForm, QueueBatchForm, QueueBatchForm, QueueConstrainerEnablerForm, QueueConstrainerEnablerForm, QueueConstrainerEnablerFormRecord, QueueConstrainerEnablerFormRecord, QueueConstrainerForm, QueueConstrainerForm, QueueConstrainerFormRecord, QueueConstrainerFormRecord, QueueForm, QueueForm, QueueProcessorEnablerForm, QueueProcessorEnablerForm, QueueProcessorEnablerFormRecord, QueueProcessorEnablerFormRecord, QueueProcessorForm, QueueProcessorForm, QueueProcessorFormRecord, QueueProcessorFormRecord, RaceBatchForm, RaceConstrainerEnablerForm, RaceConstrainerEnablerFormRecord, RaceConstrainerForm, RaceConstrainerFormRecord, RaceForm, RaceProcessorEnablerForm, RaceProcessorEnablerFormRecord, RaceProcessorForm, RaceProcessorFormRecord, RecurringEventBatchForm, RecurringEventEnablerForm, RecurringEventEnablerFormRecord, RecurringEventForm, RelationshipEnablerForm, RelationshipEnablerFormRecord, RelevancyEnablerForm, RelevancyEnablerFormRecord, RequisiteForm, SequenceRuleEnablerForm, SequenceRuleEnablerFormRecord, SequenceRuleForm, SignalBatchForm, SignalEnablerForm, SignalEnablerFormRecord, SignalForm, SpeedZoneBatchForm, SpeedZoneEnablerForm, SpeedZoneEnablerFormRecord, SpeedZoneForm, StepBatchForm, StepConstrainerEnablerForm, StepConstrainerEnablerFormRecord, StepConstrainerForm, StepConstrainerFormRecord, StepForm, StepProcessorEnablerForm, StepProcessorEnablerFormRecord, StepProcessorForm, StepProcessorFormRecord, SubscriptionEnablerForm, SubscriptionEnablerFormRecord, SupersedingEventEnablerForm, SupersedingEventEnablerFormRecord, SupersedingEventForm, TodoProducerForm, TodoProducerFormRecord, TriggerBatchForm, TriggerEnablerForm, TriggerEnablerFormRecord, TriggerForm, ValueBatchForm, ValueEnablerForm, ValueEnablerFormRecord, ValueForm

public interface OsidOperableForm
extends OsidForm

This form is used to create and update operables.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearDisabled() Removes the administratively disabled flag.
void	clearEnabled() Removes the administratively enabled flag.
Metadata	getDisabledMetadata() Gets the metadata for the disabled flag.
Metadata	getEnabledMetadata() Gets the metadata for the enabled flag.
void	setDisabled(boolean disabled) Sets the administratively disabled flag.
void	setEnabled(boolean enabled) Sets the administratively enabled flag.

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

Method Detail

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.