org.osid

Interface OsidEnablerForm

All Superinterfaces:

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

All Known Subinterfaces:

ActionEnablerForm, AuctionConstrainerEnablerForm, AuctionProcessorEnablerForm, AuditEnablerForm, AuthorizationEnablerForm, AvailabilityEnablerForm, BallotConstrainerEnablerForm, BrokerConstrainerEnablerForm, BrokerProcessorEnablerForm, CanonicalUnitEnablerForm, CanonicalUnitProcessorEnablerForm, CatalogEnablerForm, CommissionEnablerForm, CommitmentEnablerForm, CompositionEnablerForm, ContactEnablerForm, DemographicEnablerForm, DeviceEnablerForm, EdgeEnablerForm, HoldEnablerForm, InputEnablerForm, InquiryEnablerForm, InstructionForm, JobConstrainerEnablerForm, JobProcessorEnablerForm, ObstacleEnablerForm, OfferingConstrainerEnablerForm, OffsetEventEnablerForm, ParameterProcessorEnablerForm, PoolConstrainerEnablerForm, PoolProcessorEnablerForm, PriceEnablerForm, ProcessEnablerForm, ProfileEntryEnablerForm, QueueConstrainerEnablerForm, QueueConstrainerEnablerForm, QueueProcessorEnablerForm, QueueProcessorEnablerForm, RaceConstrainerEnablerForm, RaceProcessorEnablerForm, RecurringEventEnablerForm, RelationshipEnablerForm, RelevancyEnablerForm, RequisiteForm, SequenceRuleEnablerForm, SignalEnablerForm, SpeedZoneEnablerForm, StepConstrainerEnablerForm, StepProcessorEnablerForm, SubscriptionEnablerForm, SupersedingEventEnablerForm, TriggerEnablerForm, ValueEnablerForm

public interface OsidEnablerForm
extends OsidRuleForm, OsidTemporalForm

This form is used to create and update enablers.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearCyclicEvent() Removes the cyclic event.
void	clearDemographic() Removes the resource demographic.
void	clearEvent() Removes the event.
void	clearSchedule() Removes the schedule.
Metadata	getCyclicEventMetadata() Gets the metadata for the cyclic event.
Metadata	getDemographicMetadata() Gets the metadata for an associated demographic.
Metadata	getEventMetadata() Gets the metadata for an associated event.
Metadata	getScheduleMetadata() Gets the metadata for an associated schedule.
void	setCyclicEvent(Id cyclicEventId) Sets the cyclic event.
void	setDemographic(Id resourceId) Sets a resource demographic.
void	setEvent(Id eventId) Sets an event.
void	setSchedule(Id scheduleId) Sets a schedule.

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

Methods inherited from interface org.osid.OsidTemporalForm

clearEndDate, clearStartDate, getEndDateMetadata, getStartDateMetadata, setEndDate, setStartDate

Method Detail

getScheduleMetadata

Metadata getScheduleMetadata()

Gets the metadata for an associated schedule.

Returns:

metadata for the schedule

Compliance:

mandatory - This method must be implemented.

setSchedule

void setSchedule(Id scheduleId)

Sets a schedule.

Parameters:

scheduleId - the new schedule

Throws:

InvalidArgumentException - scheduleId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - scheduleId is null

Compliance:

mandatory - This method must be implemented.

clearSchedule

void clearSchedule()

Removes the schedule.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getEventMetadata

Metadata getEventMetadata()

Gets the metadata for an associated event.

Returns:

metadata for the event

Compliance:

mandatory - This method must be implemented.

setEvent

void setEvent(Id eventId)

Sets an event.

Parameters:

eventId - the new event

Throws:

InvalidArgumentException - eventId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - eventId is null

Compliance:

mandatory - This method must be implemented.

clearEvent

void clearEvent()

Removes the event.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getCyclicEventMetadata

Metadata getCyclicEventMetadata()

Gets the metadata for the cyclic event.

Returns:

metadata for the cyclic event

Compliance:

mandatory - This method must be implemented.

setCyclicEvent

void setCyclicEvent(Id cyclicEventId)

Sets the cyclic event.

Parameters:

cyclicEventId - the new cyclic event

Throws:

InvalidArgumentException - cyclicEventId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - cyclicEventId is null

Compliance:

mandatory - This method must be implemented.

clearCyclicEvent

void clearCyclicEvent()

Removes the cyclic event.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getDemographicMetadata

Metadata getDemographicMetadata()

Gets the metadata for an associated demographic.

Returns:

metadata for the resource.

Compliance:

mandatory - This method must be implemented.

setDemographic

void setDemographic(Id resourceId)

Sets a resource demographic.

Parameters:

resourceId - the new resource

Throws:

InvalidArgumentException - resourceId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - resourceId is null

Compliance:

mandatory - This method must be implemented.

clearDemographic

void clearDemographic()

Removes the resource demographic.

Throws:

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

Compliance:

mandatory - This method must be implemented.