org.osid

Interface OsidTemporalSearchOrder

All Superinterfaces:

OsidSearchOrder, Suppliable

All Known Subinterfaces:

ActionEnablerSearchOrder, ActivityRegistrationSearchOrder, ActivitySearchOrder, ActivitySearchOrder, AppointmentSearchOrder, AssessmentEntrySearchOrder, AuctionConstrainerEnablerSearchOrder, AuctionProcessorEnablerSearchOrder, AuctionSearchOrder, AuditEnablerSearchOrder, AuthorizationEnablerSearchOrder, AuthorizationSearchOrder, AvailabilityEnablerSearchOrder, AvailabilitySearchOrder, AwardEntrySearchOrder, BallotConstrainerEnablerSearchOrder, BallotSearchOrder, BidSearchOrder, BrokerConstrainerEnablerSearchOrder, BrokerProcessorEnablerSearchOrder, BudgetEntrySearchOrder, BudgetSearchOrder, BuildingSearchOrder, CandidateSearchOrder, CanonicalUnitEnablerSearchOrder, CanonicalUnitProcessorEnablerSearchOrder, CatalogEnablerSearchOrder, CommentSearchOrder, CommissionEnablerSearchOrder, CommissionSearchOrder, CommitmentEnablerSearchOrder, CommitmentSearchOrder, CompositionEnablerSearchOrder, ConferralSearchOrder, ContactEnablerSearchOrder, ContactSearchOrder, CourseEntrySearchOrder, CourseOfferingSearchOrder, CredentialEntrySearchOrder, CreditSearchOrder, CustomerSearchOrder, DeedSearchOrder, DemographicEnablerSearchOrder, DeviceEnablerSearchOrder, DocetSearchOrder, EdgeEnablerSearchOrder, EdgeSearchOrder, EffortSearchOrder, EnrollmentSearchOrder, EntrySearchOrder, EventSearchOrder, FloorSearchOrder, GradeEntrySearchOrder, HoldEnablerSearchOrder, HoldSearchOrder, InputEnablerSearchOrder, InquiryEnablerSearchOrder, InstructionSearchOrder, IssueSearchOrder, ItemSearchOrder, JobConstrainerEnablerSearchOrder, JobProcessorEnablerSearchOrder, LeaseSearchOrder, LessonSearchOrder, ObstacleEnablerSearchOrder, OfferingConstrainerEnablerSearchOrder, OfferingSearchOrder, OffsetEventEnablerSearchOrder, OrganizationSearchOrder, OsidEnablerSearchOrder, OsidRelationshipSearchOrder, ParameterProcessorEnablerSearchOrder, ParticipantSearchOrder, PathSearchOrder, PayerSearchOrder, PlanSearchOrder, PoolConstrainerEnablerSearchOrder, PoolProcessorEnablerSearchOrder, PositionSearchOrder, PriceEnablerSearchOrder, ProcessEnablerSearchOrder, ProficiencySearchOrder, ProfileEntryEnablerSearchOrder, ProfileEntrySearchOrder, ProgramEntrySearchOrder, ProgramOfferingSearchOrder, ProjectSearchOrder, ProvisionableSearchOrder, ProvisionSearchOrder, QueueConstrainerEnablerSearchOrder, QueueConstrainerEnablerSearchOrder, QueueProcessorEnablerSearchOrder, QueueProcessorEnablerSearchOrder, RaceConstrainerEnablerSearchOrder, RaceProcessorEnablerSearchOrder, RecurringEventEnablerSearchOrder, RegistrationSearchOrder, RelationshipEnablerSearchOrder, RelationshipSearchOrder, RelevancyEnablerSearchOrder, RelevancySearchOrder, RenovationSearchOrder, RequestSearchOrder, RequestTransactionSearchOrder, RequisiteSearchOrder, ResourceRelationshipSearchOrder, ResponseSearchOrder, ResultSearchOrder, RoomSearchOrder, RouteSearchOrder, SequenceRuleEnablerSearchOrder, SignalEnablerSearchOrder, SpeedZoneEnablerSearchOrder, StepConstrainerEnablerSearchOrder, StepProcessorEnablerSearchOrder, SubscriptionEnablerSearchOrder, SubscriptionSearchOrder, SupersedingEventEnablerSearchOrder, TodoSearchOrder, TriggerEnablerSearchOrder, ValueEnablerSearchOrder, VoteSearchOrder

public interface OsidTemporalSearchOrder
extends OsidSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
void	orderByEffective(SearchOrderStyle style) Specifies a preference for ordering the result set by the effective status.
void	orderByEndDate(SearchOrderStyle style) Specifies a preference for ordering the result set by the end date.
void	orderByStartDate(SearchOrderStyle style) Specifies a preference for ordering the result set by the start date.

Method Detail

orderByEffective

void orderByEffective(SearchOrderStyle style)

Specifies a preference for ordering the result set by the effective status.

Parameters:

style - the search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByStartDate

void orderByStartDate(SearchOrderStyle style)

Specifies a preference for ordering the result set by the start date.

Parameters:

style - the search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByEndDate

void orderByEndDate(SearchOrderStyle style)

Specifies a preference for ordering the result set by the end date.

Parameters:

style - the search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.