Interface Temporal

All Known Subinterfaces:

ActionEnabler, Activity, Activity, ActivityRegistration, Appointment, AssessmentEntry, AuctionConstrainerEnabler, AuctionProcessorEnabler, AuditConstrainerEnabler, AuditEnabler, AuditProcessorEnabler, Authorization, AuthorizationEnabler, Availability, AvailabilityEnabler, AwardEntry, Ballot, BallotConstrainerEnabler, Bid, BidEnabler, BrokerConstrainerEnabler, BrokerEnabler, BrokerProcessorEnabler, Budget, BudgetEntry, Building, Candidate, CanonicalUnitEnabler, CanonicalUnitProcessorEnabler, CatalogEnabler, Comment, Commission, CommissionEnabler, Commitment, CommitmentEnabler, CompositionEnabler, Conferral, Contact, ContactEnabler, CourseEntry, CourseOffering, CourseRegistration, CredentialEntry, Credit, Customer, Deed, DemographicEnabler, DeviceEnabler, DispatchConstrainerEnabler, DispatchEnabler, DispatchProcessorEnabler, Docet, Edge, EdgeEnabler, Effort, Enrollment, Entry, Event, Floor, GradeEntry, Hold, HoldEnabler, Input, InputEnabler, InquiryEnabler, Instruction, Issue, IssueConstrainerEnabler, IssueEnabler, IssueProcessorEnabler, Item, JobConstrainerEnabler, JobProcessorEnabler, Lease, Lesson, ObstacleEnabler, Offering, OfferingConstrainerEnabler, OffsetEventEnabler, Organization, OsidEffectuator, OsidEnabler, OsidOperator, OsidRelationship, OsidRuleApplicator, ParameterProcessorEnabler, Participant, Path, Payer, Plan, PoolConstrainerEnabler, PoolEnabler, PoolProcessorEnabler, Position, PriceEnabler, ProcessConstrainerEnabler, ProcessEnabler, ProcessProcessorEnabler, Proficiency, ProfileEntry, ProfileEntryEnabler, ProgramEntry, ProgramOffering, Project, Provision, Provisionable, ProvisionableEnabler, ProvisionEnabler, QueueConstrainerEnabler, QueueConstrainerEnabler, QueueEnabler, QueueEnabler, QueueProcessorEnabler, QueueProcessorEnabler, RaceConstrainerEnabler, RaceProcessorEnabler, RecurringEventEnabler, Registration, Relationship, RelationshipEnabler, Relevancy, RelevancyEnabler, Renovation, Request, RequestTransaction, Requisite, ResourceRelationship, Response, Result, Room, Route, SequenceRuleEnabler, SignalEnabler, SpeedZoneEnabler, StepConstrainerEnabler, StepEnabler, StepProcessorEnabler, Subscription, SubscriptionEnabler, SupersedingEventEnabler, Todo, TriggerEnabler, ValueEnabler, Vote, VoteEnabler

public interface Temporal

Temporal is used to indicate the object endures for a period of time.

Method Summary

Modifier and Type	Method	Description
DateTime	getEndDate()	Gets the end date.
DateTime	getStartDate()	Gets the start date.
boolean	isEffective()	Tests if the current date is within the start end end dates inclusive.

Method Details

isEffective

boolean isEffective()

Tests if the current date is within the start end end dates inclusive. The current date may be the real date or the supplied current date in the context of the running service. Temporals may be evaluated against other dates in which case it is possible that the Temporal is relevant at points in time where isEffective() is false .

Returns:

true if this is effective, false otherwise

Compliance:

mandatory - This method must be implemented.

getStartDate

DateTime getStartDate()

Gets the start date.

Returns:

the start date

Compliance:

mandatory - This method must be implemented.

getEndDate

DateTime getEndDate()

Gets the end date.

Returns:

the end date

Compliance:

mandatory - This method must be implemented.