org.osid

Interface OsidTemporalQuery

All Superinterfaces:

OsidQuery, Suppliable

All Known Subinterfaces:

ActionEnablerQuery, ActivityQuery, ActivityQuery, ActivityRegistrationQuery, AppointmentQuery, AssessmentEntryQuery, AuctionConstrainerEnablerQuery, AuctionProcessorEnablerQuery, AuctionQuery, AuditEnablerQuery, AuthorizationEnablerQuery, AuthorizationQuery, AvailabilityEnablerQuery, AvailabilityQuery, AwardEntryQuery, BallotConstrainerEnablerQuery, BallotQuery, BidQuery, BrokerConstrainerEnablerQuery, BrokerProcessorEnablerQuery, BudgetEntryQuery, BudgetQuery, BuildingQuery, CandidateQuery, CanonicalUnitEnablerQuery, CanonicalUnitProcessorEnablerQuery, CatalogEnablerQuery, CommentQuery, CommissionEnablerQuery, CommissionQuery, CommitmentEnablerQuery, CommitmentQuery, CompositionEnablerQuery, ConferralQuery, ContactEnablerQuery, ContactQuery, CourseEntryQuery, CourseOfferingQuery, CredentialEntryQuery, CreditQuery, CustomerQuery, DeedQuery, DemographicEnablerQuery, DeviceEnablerQuery, DocetQuery, EdgeEnablerQuery, EdgeQuery, EffortQuery, EnrollmentQuery, EntryQuery, EventQuery, FloorQuery, GradeEntryQuery, HoldEnablerQuery, HoldQuery, InputEnablerQuery, InquiryEnablerQuery, InstructionQuery, IssueQuery, ItemQuery, JobConstrainerEnablerQuery, JobProcessorEnablerQuery, LeaseQuery, LessonQuery, ObstacleEnablerQuery, OfferingConstrainerEnablerQuery, OfferingQuery, OffsetEventEnablerQuery, OrganizationQuery, OsidEnablerQuery, OsidRelationshipQuery, ParameterProcessorEnablerQuery, ParticipantQuery, PathQuery, PayerQuery, PlanQuery, PoolConstrainerEnablerQuery, PoolProcessorEnablerQuery, PositionQuery, PriceEnablerQuery, ProcessEnablerQuery, ProficiencyQuery, ProfileEntryEnablerQuery, ProfileEntryQuery, ProgramEntryQuery, ProgramOfferingQuery, ProjectQuery, ProvisionableQuery, ProvisionQuery, QueueConstrainerEnablerQuery, QueueConstrainerEnablerQuery, QueueProcessorEnablerQuery, QueueProcessorEnablerQuery, RaceConstrainerEnablerQuery, RaceProcessorEnablerQuery, RecurringEventEnablerQuery, RegistrationQuery, RelationshipEnablerQuery, RelationshipQuery, RelevancyEnablerQuery, RelevancyQuery, RenovationQuery, RequestQuery, RequestTransactionQuery, RequisiteQuery, ResourceRelationshipQuery, ResponseQuery, ResultQuery, RoomQuery, RouteQuery, SequenceRuleEnablerQuery, SignalEnablerQuery, SpeedZoneEnablerQuery, StepConstrainerEnablerQuery, StepProcessorEnablerQuery, SubscriptionEnablerQuery, SubscriptionQuery, SupersedingEventEnablerQuery, TodoQuery, TriggerEnablerQuery, ValueEnablerQuery, VoteQuery

public interface OsidTemporalQuery
extends OsidQuery

This is the query interface for searching temporal objects. Each method specifies an AND term while multiple invocations of the same method produce a nested OR.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearDateTerms() Clears the date query terms.
void	clearEffectiveTerms() Clears the effective query terms.
void	clearEndDateTerms() Clears the end date query terms.
void	clearStartDateTerms() Clears the start date query terms.
void	matchAnyEndDate(boolean match) Matches temporals with any end date set.
void	matchAnyStartDate(boolean match) Matches temporals with any start date set.
void	matchDate(DateTime from, DateTime to, boolean match) Matches temporals where the given date range falls entirely between the start and end dates inclusive.
void	matchEffective(boolean match) Match effective objects where the current date falls within the start and end dates inclusive.
void	matchEndDate(DateTime start, DateTime end, boolean match) Matches temporals whose effective end date falls in between the given dates inclusive.
void	matchStartDate(DateTime start, DateTime end, boolean match) Matches temporals whose start date falls in between the given dates inclusive.

Methods inherited from interface org.osid.OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Method Detail

matchEffective

void matchEffective(boolean match)

Match effective objects where the current date falls within the start and end dates inclusive.

Parameters:

match - true to match any effective, false to match ineffective

Compliance:

mandatory - This method must be implemented.

clearEffectiveTerms

void clearEffectiveTerms()

Clears the effective query terms.

Compliance:

mandatory - This method must be implemented.

matchStartDate

void matchStartDate(DateTime start,
                  DateTime end,
                  boolean match)

Matches temporals whose start date falls in between the given dates inclusive.

Parameters:

start - start of date range

end - end of date range

match - true if a positive match, false for a negative match

Throws:

InvalidArgumentException - start is less than end

NullArgumentException - start or end is null

Compliance:

mandatory - This method must be implemented.

matchAnyStartDate

void matchAnyStartDate(boolean match)

Matches temporals with any start date set.

Parameters:

match - true to match any start date, false to match no start date

Compliance:

mandatory - This method must be implemented.

clearStartDateTerms

void clearStartDateTerms()

Clears the start date query terms.

Compliance:

mandatory - This method must be implemented.

matchEndDate

void matchEndDate(DateTime start,
                DateTime end,
                boolean match)

Matches temporals whose effective end date falls in between the given dates inclusive.

Parameters:

start - start of date range

end - end of date range

match - true if a positive match, false for negative match

Throws:

InvalidArgumentException - start is less than end

NullArgumentException - start or end is null

Compliance:

mandatory - This method must be implemented.

matchAnyEndDate

void matchAnyEndDate(boolean match)

Matches temporals with any end date set.

Parameters:

match - true to match any end date, false to match no start date

Compliance:

mandatory - This method must be implemented.

clearEndDateTerms

void clearEndDateTerms()

Clears the end date query terms.

Compliance:

mandatory - This method must be implemented.

matchDate

void matchDate(DateTime from,
             DateTime to,
             boolean match)

Matches temporals where the given date range falls entirely between the start and end dates inclusive.

Parameters:

from - start date

to - end date

match - true if a positive match, false for a negative match

Throws:

InvalidArgumentException - from is less than to

NullArgumentException - from or to is null

Compliance:

mandatory - This method must be implemented.

clearDateTerms

void clearDateTerms()

Clears the date query terms.

Compliance:

mandatory - This method must be implemented.