org.osid

Interface OsidTemporalForm

All Superinterfaces:

Identifiable, OsidForm, Suppliable

All Known Subinterfaces:

ActionEnablerForm, ActivityBatchForm, ActivityBatchForm, ActivityForm, ActivityForm, ActivityRegistrationBatchForm, ActivityRegistrationForm, AppointmentBatchForm, AppointmentForm, AuctionBatchForm, AuctionConstrainerEnablerForm, AuctionForm, AuctionProcessorEnablerForm, AuditEnablerForm, AuthorizationBatchForm, AuthorizationEnablerForm, AuthorizationForm, AvailabilityBatchForm, AvailabilityEnablerForm, AvailabilityForm, AwardEntryBatchForm, AwardEntryForm, BallotBatchForm, BallotConstrainerEnablerForm, BallotForm, BidBatchForm, BidForm, BrokerConstrainerEnablerForm, BrokerProcessorEnablerForm, BudgetEntryForm, BudgetForm, BuildingBatchForm, BuildingForm, CandidateBatchForm, CandidateForm, CanonicalUnitEnablerForm, CanonicalUnitProcessorEnablerForm, CatalogEnablerForm, CommentBatchForm, CommentForm, CommissionBatchForm, CommissionEnablerForm, CommissionForm, CommitmentBatchForm, CommitmentEnablerForm, CommitmentForm, CompositionEnablerForm, ConferralBatchForm, ConferralForm, ContactBatchForm, ContactEnablerForm, ContactForm, CourseEntryBatchForm, CourseEntryForm, CourseOfferingBatchForm, CourseOfferingForm, CredentialEntryBatchForm, CredentialEntryForm, CreditBatchForm, CreditForm, CustomerBatchForm, CustomerForm, DeedBatchForm, DeedForm, DemographicEnablerForm, DeviceEnablerForm, DocetBatchForm, DocetForm, EdgeBatchForm, EdgeEnablerForm, EdgeForm, EffortBatchForm, EffortForm, EnrollmentBatchForm, EnrollmentForm, EntryBatchForm, EntryForm, EventBatchForm, EventForm, FloorBatchForm, FloorForm, GradeEntryBatchForm, GradeEntryForm, HoldBatchForm, HoldEnablerForm, HoldForm, InputEnablerForm, InquiryEnablerForm, InstructionForm, IssueBatchForm, IssueForm, ItemBatchForm, ItemForm, JobConstrainerEnablerForm, JobProcessorEnablerForm, LeaseBatchForm, LeaseForm, LessonForm, ObstacleEnablerForm, OfferingBatchForm, OfferingConstrainerEnablerForm, OfferingForm, OffsetEventEnablerForm, OrganizationBatchForm, OrganizationForm, OsidEnablerForm, OsidRelationshipForm, ParameterProcessorEnablerForm, ParticipantBatchForm, ParticipantForm, PathForm, PayerBatchForm, PayerForm, PlanForm, PoolConstrainerEnablerForm, PoolProcessorEnablerForm, PositionBatchForm, PositionForm, PriceEnablerForm, ProcessEnablerForm, ProficiencyBatchForm, ProficiencyForm, ProfileEntryEnablerForm, ProgramEntryBatchForm, ProgramEntryForm, ProgramOfferingBatchForm, ProgramOfferingForm, ProjectBatchForm, ProjectForm, ProvisionableBatchForm, ProvisionableForm, ProvisionBatchForm, ProvisionForm, QueueConstrainerEnablerForm, QueueConstrainerEnablerForm, QueueProcessorEnablerForm, QueueProcessorEnablerForm, RaceConstrainerEnablerForm, RaceProcessorEnablerForm, RecurringEventEnablerForm, RegistrationBatchForm, RegistrationForm, RelationshipBatchForm, RelationshipEnablerForm, RelationshipForm, RelevancyBatchForm, RelevancyEnablerForm, RelevancyForm, RenovationBatchForm, RenovationForm, RequestBatchForm, RequestForm, RequestTransactionBatchForm, RequestTransactionForm, RequisiteForm, ResourceRelationshipBatchForm, ResourceRelationshipForm, ResponseBatchForm, ResponseForm, ResultBatchForm, ResultForm, RoomBatchForm, RoomForm, RouteForm, SequenceRuleEnablerForm, SignalEnablerForm, SpeedZoneEnablerForm, StepConstrainerEnablerForm, StepProcessorEnablerForm, SubscriptionBatchForm, SubscriptionEnablerForm, SubscriptionForm, SupersedingEventEnablerForm, TodoBatchForm, TodoForm, TriggerEnablerForm, ValueEnablerForm, VoteBatchForm, VoteForm

public interface OsidTemporalForm
extends OsidForm

This form is used to create and update temporals.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearEndDate() Clears the end date.
void	clearStartDate() Clears the start date.
Metadata	getEndDateMetadata() Gets the metadata for an end date.
Metadata	getStartDateMetadata() Gets the metadata for a start date.
void	setEndDate(DateTime date) Sets the end date.
void	setStartDate(DateTime date) Sets the start date.

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

getStartDateMetadata

Metadata getStartDateMetadata()

Gets the metadata for a start date.

Returns:

metadata for the date

Compliance:

mandatory - This method must be implemented.

setStartDate

void setStartDate(DateTime date)

Sets the start date.

Parameters:

date - the new date

Throws:

InvalidArgumentException - date is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - date is null

Compliance:

mandatory - This method must be implemented.

clearStartDate

void clearStartDate()

Clears the start date.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getEndDateMetadata

Metadata getEndDateMetadata()

Gets the metadata for an end date.

Returns:

metadata for the date

Compliance:

mandatory - This method must be implemented.

setEndDate

void setEndDate(DateTime date)

Sets the end date.

Parameters:

date - the new date

Throws:

InvalidArgumentException - date is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - date is null

Compliance:

mandatory - This method must be implemented.

clearEndDate

void clearEndDate()

Clears the end date.

Throws:

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

Compliance:

mandatory - This method must be implemented.