org.osid

Interface OsidRuleSearchOrder

All Superinterfaces:

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

All Known Subinterfaces:

ActionEnablerSearchOrder, AuctionConstrainerEnablerSearchOrder, AuctionConstrainerSearchOrder, AuctionProcessorEnablerSearchOrder, AuctionProcessorSearchOrder, AuditEnablerSearchOrder, AuthorizationEnablerSearchOrder, AvailabilityEnablerSearchOrder, BallotConstrainerEnablerSearchOrder, BallotConstrainerSearchOrder, BrokerConstrainerEnablerSearchOrder, BrokerConstrainerSearchOrder, BrokerProcessorEnablerSearchOrder, BrokerProcessorSearchOrder, CanonicalUnitEnablerSearchOrder, CanonicalUnitProcessorEnablerSearchOrder, CanonicalUnitProcessorSearchOrder, CatalogEnablerSearchOrder, CheckSearchOrder, CommissionEnablerSearchOrder, CommitmentEnablerSearchOrder, CompositionEnablerSearchOrder, ContactEnablerSearchOrder, DemographicEnablerSearchOrder, DemographicSearchOrder, DeviceEnablerSearchOrder, EdgeEnablerSearchOrder, FunctionSearchOrder, GradebookColumnSummarySearchOrder, HoldEnablerSearchOrder, InputEnablerSearchOrder, InputSearchOrder, InquiryEnablerSearchOrder, InquirySearchOrder, InstructionSearchOrder, JobConstrainerEnablerSearchOrder, JobConstrainerSearchOrder, JobProcessorEnablerSearchOrder, JobProcessorSearchOrder, ObstacleEnablerSearchOrder, OfferingConstrainerEnablerSearchOrder, OfferingConstrainerSearchOrder, OffsetEventEnablerSearchOrder, OffsetEventSearchOrder, OsidConstrainerSearchOrder, OsidEnablerSearchOrder, OsidProcessorSearchOrder, ParameterProcessorEnablerSearchOrder, ParameterProcessorSearchOrder, ParameterSearchOrder, PoolConstrainerEnablerSearchOrder, PoolConstrainerSearchOrder, PoolProcessorEnablerSearchOrder, PoolProcessorSearchOrder, PriceEnablerSearchOrder, PriceSearchOrder, ProcessEnablerSearchOrder, ProfileEntryEnablerSearchOrder, QueueConstrainerEnablerSearchOrder, QueueConstrainerEnablerSearchOrder, QueueConstrainerSearchOrder, QueueConstrainerSearchOrder, QueueProcessorEnablerSearchOrder, QueueProcessorEnablerSearchOrder, QueueProcessorSearchOrder, QueueProcessorSearchOrder, RaceConstrainerEnablerSearchOrder, RaceConstrainerSearchOrder, RaceProcessorEnablerSearchOrder, RaceProcessorSearchOrder, RecurringEventEnablerSearchOrder, RecurringEventSearchOrder, RelationshipEnablerSearchOrder, RelevancyEnablerSearchOrder, RequisiteSearchOrder, RuleSearchOrder, SequenceRuleEnablerSearchOrder, SequenceRuleSearchOrder, SignalEnablerSearchOrder, SignalSearchOrder, SpeedZoneEnablerSearchOrder, SpeedZoneSearchOrder, StepConstrainerEnablerSearchOrder, StepConstrainerSearchOrder, StepProcessorEnablerSearchOrder, StepProcessorSearchOrder, SubscriptionEnablerSearchOrder, SupersedingEventEnablerSearchOrder, SupersedingEventSearchOrder, TodoProducerSearchOrder, TriggerEnablerSearchOrder, TriggerSearchOrder, ValueEnablerSearchOrder

public interface OsidRuleSearchOrder
extends OsidObjectSearchOrder, OsidOperableSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
RuleSearchOrder	getRuleSearchOrder() Gets the search order for a rule.
void	orderByRule(SearchOrderStyle style) Specifies a preference for ordering the results by the associated rule.
boolean	supportsRuleSearchOrder() Tests if a RuleSearchOrder is available.

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

Method Detail

orderByRule

void orderByRule(SearchOrderStyle style)

Specifies a preference for ordering the results by the associated rule. The element of the rule to order is not specified but may be managed through a RuleSearchOrder.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsRuleSearchOrder

boolean supportsRuleSearchOrder()

Tests if a RuleSearchOrder is available.

Returns:

true if a rule search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRuleSearchOrder

RuleSearchOrder getRuleSearchOrder()

Gets the search order for a rule.

Returns:

the rule search order

Throws:

UnimplementedException - supportsRuleSearchOrder() is false

Compliance:

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