org.osid

Interface OsidEnablerSearchOrder

All Superinterfaces:

Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidOperableSearchOrder, OsidRuleSearchOrder, OsidSearchOrder, OsidTemporalSearchOrder, Suppliable

All Known Subinterfaces:

ActionEnablerSearchOrder, AuctionConstrainerEnablerSearchOrder, AuctionProcessorEnablerSearchOrder, AuditEnablerSearchOrder, AuthorizationEnablerSearchOrder, AvailabilityEnablerSearchOrder, BallotConstrainerEnablerSearchOrder, BrokerConstrainerEnablerSearchOrder, BrokerProcessorEnablerSearchOrder, CanonicalUnitEnablerSearchOrder, CanonicalUnitProcessorEnablerSearchOrder, CatalogEnablerSearchOrder, CommissionEnablerSearchOrder, CommitmentEnablerSearchOrder, CompositionEnablerSearchOrder, ContactEnablerSearchOrder, DemographicEnablerSearchOrder, DeviceEnablerSearchOrder, EdgeEnablerSearchOrder, HoldEnablerSearchOrder, InputEnablerSearchOrder, InquiryEnablerSearchOrder, InstructionSearchOrder, JobConstrainerEnablerSearchOrder, JobProcessorEnablerSearchOrder, ObstacleEnablerSearchOrder, OfferingConstrainerEnablerSearchOrder, OffsetEventEnablerSearchOrder, ParameterProcessorEnablerSearchOrder, PoolConstrainerEnablerSearchOrder, PoolProcessorEnablerSearchOrder, PriceEnablerSearchOrder, ProcessEnablerSearchOrder, ProfileEntryEnablerSearchOrder, QueueConstrainerEnablerSearchOrder, QueueConstrainerEnablerSearchOrder, QueueProcessorEnablerSearchOrder, QueueProcessorEnablerSearchOrder, RaceConstrainerEnablerSearchOrder, RaceProcessorEnablerSearchOrder, RecurringEventEnablerSearchOrder, RelationshipEnablerSearchOrder, RelevancyEnablerSearchOrder, RequisiteSearchOrder, SequenceRuleEnablerSearchOrder, SignalEnablerSearchOrder, SpeedZoneEnablerSearchOrder, StepConstrainerEnablerSearchOrder, StepProcessorEnablerSearchOrder, SubscriptionEnablerSearchOrder, SupersedingEventEnablerSearchOrder, TriggerEnablerSearchOrder, ValueEnablerSearchOrder

public interface OsidEnablerSearchOrder
extends OsidRuleSearchOrder, OsidTemporalSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
CyclicEventSearchOrder	getCyclicEventSearchOrder() Gets the cyclic event search order.
ResourceSearchOrder	getDemographicSearchOrder() Gets the search order for a demographic resource.
EventSearchOrder	getEventSearchOrder() Gets the search order for an event.
ScheduleSearchOrder	getScheduleSearchOrder() Gets the search order for a schedule.
void	orderByCyclicEvent(SearchOrderStyle style) Orders the results by cyclic event.
void	orderByDemographic(SearchOrderStyle style) Specifies a preference for ordering the results by the associated demographic resource.
void	orderByEvent(SearchOrderStyle style) Specifies a preference for ordering the results by the associated event.
void	orderBySchedule(SearchOrderStyle style) Specifies a preference for ordering the results by the associated schedule.
boolean	supportsCyclicEventSearchOrder() Tests if a cyclic event search order is available.
boolean	supportsDemographicSearchOrder() Tests if a ResourceSearchOrder is available.
boolean	supportsEventSearchOrder() Tests if an EventSearchOrder is available.
boolean	supportsScheduleSearchOrder() Tests if a ScheduleSearchOrder is available.

Methods inherited from interface org.osid.OsidRuleSearchOrder

getRuleSearchOrder, orderByRule, supportsRuleSearchOrder

Methods inherited from interface org.osid.OsidObjectSearchOrder

orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic

Methods inherited from interface org.osid.OsidIdentifiableSearchOrder

orderById

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidOperableSearchOrder

orderByActive, orderByDisabled, orderByEnabled, orderByOperational

Methods inherited from interface org.osid.OsidTemporalSearchOrder

orderByEffective, orderByEndDate, orderByStartDate

Method Detail

orderBySchedule

void orderBySchedule(SearchOrderStyle style)

Specifies a preference for ordering the results by the associated schedule.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsScheduleSearchOrder

boolean supportsScheduleSearchOrder()

Tests if a ScheduleSearchOrder is available.

Returns:

true if a schedule search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getScheduleSearchOrder

ScheduleSearchOrder getScheduleSearchOrder()

Gets the search order for a schedule.

Returns:

the schedule search order

Throws:

UnimplementedException - supportsScheduleSearchOrder() is false

Compliance:

optional - This method must be implemented if supportsScheduleSearchOrder() is true.

orderByEvent

void orderByEvent(SearchOrderStyle style)

Specifies a preference for ordering the results by the associated event.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsEventSearchOrder

boolean supportsEventSearchOrder()

Tests if an EventSearchOrder is available.

Returns:

true if an event search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getEventSearchOrder

EventSearchOrder getEventSearchOrder()

Gets the search order for an event.

Returns:

the event search order

Throws:

UnimplementedException - supportsEventSearchOrder() is false

Compliance:

optional - This method must be implemented if supportsEventSearchOrder() is true.

orderByCyclicEvent

void orderByCyclicEvent(SearchOrderStyle style)

Orders the results by cyclic event.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsCyclicEventSearchOrder

boolean supportsCyclicEventSearchOrder()

Tests if a cyclic event search order is available.

Returns:

true if a cyclic event search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getCyclicEventSearchOrder

CyclicEventSearchOrder getCyclicEventSearchOrder()

Gets the cyclic event search order.

Returns:

the cyclic event search order

Throws:

IllegalStateException - supportsCyclicEventSearchOrder() is false

Compliance:

mandatory - This method must be implemented.

orderByDemographic

void orderByDemographic(SearchOrderStyle style)

Specifies a preference for ordering the results by the associated demographic resource.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsDemographicSearchOrder

boolean supportsDemographicSearchOrder()

Tests if a ResourceSearchOrder is available.

Returns:

true if a resource search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getDemographicSearchOrder

ResourceSearchOrder getDemographicSearchOrder()

Gets the search order for a demographic resource.

Returns:

the resource search order

Throws:

UnimplementedException - supportsDemographicSearchOrder() is false

Compliance:

optional - This method must be implemented if supportsDemographicSearchOrder() is true.