org.osid

Interface OsidOperableSearchOrder

All Superinterfaces:

OsidSearchOrder, Suppliable

All Known Subinterfaces:

ActionEnablerSearchOrder, ActivityUnitSearchOrder, AssessmentPartSearchOrder, AuctionConstrainerEnablerSearchOrder, AuctionConstrainerSearchOrder, AuctionProcessorEnablerSearchOrder, AuctionProcessorSearchOrder, AuctionSearchOrder, AuditEnablerSearchOrder, AuditSearchOrder, AuthorizationEnablerSearchOrder, AvailabilityEnablerSearchOrder, BallotConstrainerEnablerSearchOrder, BallotConstrainerSearchOrder, BallotSearchOrder, BranchSearchOrder, BrokerConstrainerEnablerSearchOrder, BrokerConstrainerSearchOrder, BrokerProcessorEnablerSearchOrder, BrokerProcessorSearchOrder, BrokerSearchOrder, CanonicalUnitEnablerSearchOrder, CanonicalUnitProcessorEnablerSearchOrder, CanonicalUnitProcessorSearchOrder, CanonicalUnitSearchOrder, CatalogEnablerSearchOrder, CheckSearchOrder, CommissionEnablerSearchOrder, CommitmentEnablerSearchOrder, CompositionEnablerSearchOrder, CompositionSearchOrder, ContactEnablerSearchOrder, ControllerSearchOrder, ConvocationSearchOrder, CourseSearchOrder, DemographicEnablerSearchOrder, DemographicSearchOrder, DeviceEnablerSearchOrder, DispatchSearchOrder, EdgeEnablerSearchOrder, FunctionSearchOrder, GradebookColumnSummarySearchOrder, HoldEnablerSearchOrder, InputEnablerSearchOrder, InputSearchOrder, InquiryEnablerSearchOrder, InquirySearchOrder, InstructionSearchOrder, JobConstrainerEnablerSearchOrder, JobConstrainerSearchOrder, JobProcessorEnablerSearchOrder, JobProcessorSearchOrder, JobSearchOrder, ModuleSearchOrder, ObstacleEnablerSearchOrder, ObstacleSearchOrder, OfferingConstrainerEnablerSearchOrder, OfferingConstrainerSearchOrder, OffsetEventEnablerSearchOrder, OffsetEventSearchOrder, OsidConstrainerSearchOrder, OsidEnablerSearchOrder, OsidGovernatorSearchOrder, OsidProcessorSearchOrder, OsidRuleSearchOrder, ParameterProcessorEnablerSearchOrder, ParameterProcessorSearchOrder, ParameterSearchOrder, PoolConstrainerEnablerSearchOrder, PoolConstrainerSearchOrder, PoolProcessorEnablerSearchOrder, PoolProcessorSearchOrder, PoolSearchOrder, PriceEnablerSearchOrder, PriceSearchOrder, ProcessEnablerSearchOrder, ProcessSearchOrder, ProfileEntryEnablerSearchOrder, ProgramSearchOrder, QueueConstrainerEnablerSearchOrder, QueueConstrainerEnablerSearchOrder, QueueConstrainerSearchOrder, QueueConstrainerSearchOrder, QueueProcessorEnablerSearchOrder, QueueProcessorEnablerSearchOrder, QueueProcessorSearchOrder, QueueProcessorSearchOrder, QueueSearchOrder, QueueSearchOrder, RaceConstrainerEnablerSearchOrder, RaceConstrainerSearchOrder, RaceProcessorEnablerSearchOrder, RaceProcessorSearchOrder, RaceSearchOrder, RecurringEventEnablerSearchOrder, RecurringEventSearchOrder, RelationshipEnablerSearchOrder, RelevancyEnablerSearchOrder, RequisiteSearchOrder, RuleSearchOrder, SequenceRuleEnablerSearchOrder, SequenceRuleSearchOrder, SignalEnablerSearchOrder, SignalSearchOrder, SpeedZoneEnablerSearchOrder, SpeedZoneSearchOrder, StepConstrainerEnablerSearchOrder, StepConstrainerSearchOrder, StepProcessorEnablerSearchOrder, StepProcessorSearchOrder, StepSearchOrder, SubscriptionEnablerSearchOrder, SupersedingEventEnablerSearchOrder, SupersedingEventSearchOrder, TodoProducerSearchOrder, TriggerEnablerSearchOrder, TriggerSearchOrder, ValueEnablerSearchOrder, ValueSearchOrder

public interface OsidOperableSearchOrder
extends OsidSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
void	orderByActive(SearchOrderStyle style) Specifies a preference for ordering the result set by the active status.
void	orderByDisabled(SearchOrderStyle style) Specifies a preference for ordering the result set by the administratively disabled status.
void	orderByEnabled(SearchOrderStyle style) Specifies a preference for ordering the result set by the administratively enabled status.
void	orderByOperational(SearchOrderStyle style) Specifies a preference for ordering the results by the operational status.

Method Detail

orderByActive

void orderByActive(SearchOrderStyle style)

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

Parameters:

style - the search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByEnabled

void orderByEnabled(SearchOrderStyle style)

Specifies a preference for ordering the result set by the administratively enabled status.

Parameters:

style - the search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByDisabled

void orderByDisabled(SearchOrderStyle style)

Specifies a preference for ordering the result set by the administratively disabled status.

Parameters:

style - the search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByOperational

void orderByOperational(SearchOrderStyle style)

Specifies a preference for ordering the results by the operational status.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.