Interface OsidTemporalForm
- All Superinterfaces:
Identifiable, OsidForm, Suppliable
- All Known Subinterfaces:
ActionEnablerForm, ActivityBatchForm, ActivityBatchForm, ActivityForm, ActivityForm, ActivityRegistrationBatchForm, ActivityRegistrationForm, AppointmentBatchForm, AppointmentForm, AuctionConstrainerEnablerForm, AuctionProcessorEnablerForm, AuditConstrainerEnablerForm, AuditEnablerForm, AuditProcessorEnablerForm, AuthorizationBatchForm, AuthorizationEnablerForm, AuthorizationForm, AvailabilityBatchForm, AvailabilityEnablerForm, AvailabilityForm, AwardEntryBatchForm, AwardEntryForm, BallotBatchForm, BallotConstrainerEnablerForm, BallotForm, BidBatchForm, BidEnablerForm, BidForm, BrokerConstrainerEnablerForm, BrokerEnablerForm, 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, CourseRegistrationBatchForm, CourseRegistrationForm, CredentialEntryBatchForm, CredentialEntryForm, CreditBatchForm, CreditForm, CustomerBatchForm, CustomerForm, DeedBatchForm, DeedForm, DemographicEnablerForm, DeviceEnablerForm, DispatchConstrainerEnablerForm, DispatchEnablerForm, DispatchProcessorEnablerForm, DocetBatchForm, DocetForm, EdgeBatchForm, EdgeEnablerForm, EdgeForm, EffortBatchForm, EffortForm, EnrollmentBatchForm, EnrollmentForm, EntryBatchForm, EntryForm, EventBatchForm, EventForm, FloorBatchForm, FloorForm, GradeEntryBatchForm, GradeEntryForm, HoldBatchForm, HoldEnablerForm, HoldForm, InputEnablerForm, InquiryEnablerForm, InstructionForm, IssueBatchForm, IssueConstrainerEnablerForm, IssueEnablerForm, IssueForm, IssueProcessorEnablerForm, ItemBatchForm, ItemForm, JobConstrainerEnablerForm, JobProcessorEnablerForm, LeaseBatchForm, LeaseForm, LessonForm, ObstacleEnablerForm, OfferingBatchForm, OfferingConstrainerEnablerForm, OfferingForm, OffsetEventEnablerForm, OrganizationBatchForm, OrganizationForm, OsidEffectuatorForm, OsidEnablerForm, OsidOperatorForm, OsidRelationshipForm, OsidRuleApplicatorForm, ParameterProcessorEnablerForm, ParticipantBatchForm, ParticipantForm, PathForm, PayerBatchForm, PayerForm, PlanForm, PoolConstrainerEnablerForm, PoolEnablerForm, PoolProcessorEnablerForm, PositionBatchForm, PositionForm, PriceEnablerForm, ProcessConstrainerEnablerForm, ProcessEnablerForm, ProcessProcessorEnablerForm, ProficiencyBatchForm, ProficiencyForm, ProfileEntryEnablerForm, ProgramEntryBatchForm, ProgramEntryForm, ProgramOfferingBatchForm, ProgramOfferingForm, ProjectBatchForm, ProjectForm, ProvisionableBatchForm, ProvisionableEnablerForm, ProvisionableForm, ProvisionBatchForm, ProvisionEnablerForm, ProvisionForm, QueueConstrainerEnablerForm, QueueConstrainerEnablerForm, QueueEnablerForm, QueueEnablerForm, QueueProcessorEnablerForm, QueueProcessorEnablerForm, RaceConstrainerEnablerForm, RaceProcessorEnablerForm, RecurringEventEnablerForm, RegistrationBatchForm, RegistrationForm, RelationshipBatchForm, RelationshipEnablerForm, RelationshipForm, RelevancyBatchForm, RelevancyForm, RenovationBatchForm, RenovationForm, RequestBatchForm, RequestForm, RequestTransactionBatchForm, RequestTransactionForm, RequisiteForm, ResourceRelationshipBatchForm, ResourceRelationshipForm, ResponseBatchForm, ResponseForm, ResultBatchForm, ResultForm, RoomBatchForm, RoomForm, RouteForm, SequenceRuleEnablerForm, SignalEnablerForm, SpeedZoneEnablerForm, StepConstrainerEnablerForm, StepEnablerForm, StepProcessorEnablerForm, SubscriptionBatchForm, SubscriptionEnablerForm, SubscriptionForm, SupersedingEventEnablerForm, TodoBatchForm, TodoForm, TriggerEnablerForm, ValueEnablerForm, VoteBatchForm, VoteEnablerForm, VoteForm
This form is used to create and update temporals.
-
Method Summary
Modifier and TypeMethodDescriptionvoidClears the end date.voidClears the start date.Gets the metadata for an end date.Gets the metadata for a start date.voidsetEndDate(DateTime date) Sets the end date.voidsetStartDate(DateTime date) Sets the start date.Methods inherited from interface Identifiable
getId, isCurrentMethods inherited from interface OsidForm
getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocaleModifier and TypeMethodDescriptionGets a default locale for the form.Metadata[]Gets a list of metadata for the elements in this form which are not valid.Gets the metadata for the comment corresponding to this form submission.Gets the locales available for this form.Gets text messages corresponding to additional instructions to pass form validation.booleanTests if this form is for an update operation.booleanisValid()Tests if this form is in a valid state for submission.voidsetJournalComment(String comment) Sets a comment.voidSpecifies a language and script type for the form.
-
Method Details
-
getStartDateMetadata
Metadata getStartDateMetadata()Gets the metadata for a start date.- Returns:
- metadata for the date
- Compliance:
mandatory- This method must be implemented.
-
setStartDate
Sets the start date.- Parameters:
date- the new date- Throws:
InvalidArgumentException-dateis invalidNoAccessException-Metadata.isReadOnly()istrueNullArgumentException-dateisnull- Compliance:
mandatory- This method must be implemented.
-
clearStartDate
void clearStartDate()Clears the start date.- Throws:
NoAccessException-Metadata.isRequired()orMetadata.isReadOnly()istrue- 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
Sets the end date.- Parameters:
date- the new date- Throws:
InvalidArgumentException-dateis invalidNoAccessException-Metadata.isReadOnly()istrueNullArgumentException-dateisnull- Compliance:
mandatory- This method must be implemented.
-
clearEndDate
void clearEndDate()Clears the end date.- Throws:
NoAccessException-Metadata.isRequired()orMetadata.isReadOnly()istrue- Compliance:
mandatory- This method must be implemented.
-