OSID - osid.OsidEnablerSearchOrder Service Interface Definition

Interface	osid.OsidEnablerSearchOrder
Implements	`osid.OsidRuleSearchOrder`
Implements	`osid.OsidTemporalSearchOrder`
Implemented By	`osid.repository.rules.CompositionEnablerSearchOrder`
	`osid.assessment.authoring.SequenceRuleEnablerSearchOrder`
	`osid.configuration.rules.ValueEnablerSearchOrder`
	`osid.configuration.rules.ParameterProcessorEnablerSearchOrder`
	`osid.profile.rules.ProfileEntryEnablerSearchOrder`
	`osid.bidding.rules.AuctionConstrainerEnablerSearchOrder`
	`osid.bidding.rules.AuctionProcessorEnablerSearchOrder`
	`osid.bidding.rules.BidEnablerSearchOrder`
	`osid.cataloging.rules.CatalogEnablerSearchOrder`
	`osid.contact.rules.ContactEnablerSearchOrder`
	`osid.voting.rules.RaceConstrainerEnablerSearchOrder`
	`osid.voting.rules.RaceProcessorEnablerSearchOrder`
	`osid.voting.rules.BallotConstrainerEnablerSearchOrder`
	`osid.voting.rules.VoteEnablerSearchOrder`
	`osid.subscription.rules.DispatchEnablerSearchOrder`
	`osid.subscription.rules.DispatchConstrainerEnablerSearchOrder`
	`osid.subscription.rules.DispatchProcessorEnablerSearchOrder`
	`osid.subscription.rules.SubscriptionEnablerSearchOrder`
	`osid.hold.rules.IssueEnablerSearchOrder`
	`osid.hold.rules.IssueConstrainerEnablerSearchOrder`
	`osid.hold.rules.IssueProcessorEnablerSearchOrder`
	`osid.hold.rules.HoldEnablerSearchOrder`
	`osid.OsidOperatorSearchOrder`
	`osid.OsidEffectuatorSearchOrder`
	`osid.OsidRuleApplicatorSearchOrder`
	`osid.control.rules.DeviceEnablerSearchOrder`
	`osid.control.rules.InputEnablerSearchOrder`
	`osid.control.rules.TriggerEnablerSearchOrder`
	`osid.control.rules.ActionEnablerSearchOrder`
	`osid.resource.demographic.DemographicEnablerSearchOrder`
	`osid.calendaring.rules.RecurringEventEnablerSearchOrder`
	`osid.calendaring.rules.OffsetEventEnablerSearchOrder`
	`osid.calendaring.rules.SupersedingEventEnablerSearchOrder`
	`osid.calendaring.rules.CommitmentEnablerSearchOrder`
	`osid.ontology.rules.RelevancyEnablerSearchOrder`
	`osid.workflow.rules.ProcessEnablerSearchOrder`
	`osid.workflow.rules.ProcessConstrainerEnablerSearchOrder`
	`osid.workflow.rules.ProcessProcessorEnablerSearchOrder`
	`osid.workflow.rules.StepEnablerSearchOrder`
	`osid.workflow.rules.StepConstrainerEnablerSearchOrder`
	`osid.workflow.rules.StepProcessorEnablerSearchOrder`
	`osid.topology.rules.EdgeEnablerSearchOrder`
	`osid.course.requisite.RequisiteSearchOrder`
	`osid.offering.rules.CanonicalUnitEnablerSearchOrder`
	`osid.offering.rules.CanonicalUnitProcessorEnablerSearchOrder`
	`osid.offering.rules.OfferingConstrainerEnablerSearchOrder`
	`osid.ordering.rules.PriceEnablerSearchOrder`
	`osid.inquiry.rules.AuditEnablerSearchOrder`
	`osid.inquiry.rules.AuditConstrainerEnablerSearchOrder`
	`osid.inquiry.rules.AuditProcessorEnablerSearchOrder`
	`osid.inquiry.rules.InquiryEnablerSearchOrder`
	`osid.relationship.rules.RelationshipEnablerSearchOrder`
	`osid.provisioning.rules.BrokerEnablerSearchOrder`
	`osid.provisioning.rules.BrokerConstrainerEnablerSearchOrder`
	`osid.provisioning.rules.BrokerProcessorEnablerSearchOrder`
	`osid.provisioning.rules.QueueEnablerSearchOrder`
	`osid.provisioning.rules.QueueConstrainerEnablerSearchOrder`
	`osid.provisioning.rules.QueueProcessorEnablerSearchOrder`
	`osid.provisioning.rules.PoolEnablerSearchOrder`
	`osid.provisioning.rules.PoolConstrainerEnablerSearchOrder`
	`osid.provisioning.rules.PoolProcessorEnablerSearchOrder`
	`osid.provisioning.rules.ProvisionableEnablerSearchOrder`
	`osid.provisioning.rules.ProvisionEnablerSearchOrder`
	`osid.tracking.rules.QueueEnablerSearchOrder`
`osid.tracking.rules.QueueConstrainerEnablerSearchOrder`
`osid.tracking.rules.QueueProcessorEnablerSearchOrder`
`osid.resourcing.rules.AvailabilityEnablerSearchOrder`
`osid.resourcing.rules.CommissionEnablerSearchOrder`
`osid.resourcing.rules.JobConstrainerEnablerSearchOrder`
`osid.resourcing.rules.JobProcessorEnablerSearchOrder`
`osid.mapping.path.rules.SpeedZoneEnablerSearchOrder`
`osid.mapping.path.rules.SignalEnablerSearchOrder`
`osid.mapping.path.rules.ObstacleEnablerSearchOrder`
Description	An interface for specifying the ordering of search results.
Method	orderByRequirement
Description	Specifies a preference for ordering the results by the requirement flag.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderBySchedule
Description	Specifies a preference for ordering the results by the associated schedule.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsScheduleSearchOrder
Description	Tests if a `ScheduleSearchOrder` is available.
Return	`boolean`		`true` if a schedule search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getScheduleSearchOrder
Description	Gets the search order for a schedule.
Return	`osid.calendaring.ScheduleSearchOrder`		the schedule search order
Errors	UNIMPLEMENTED		`supportsScheduleSearchOrder() is false`
Compliance	`optional`		This method must be implemented if `supportsScheduleSearchOrder()` is true.
Method	orderByEvent
Description	Specifies a preference for ordering the results by the associated event.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsEventSearchOrder
Description	Tests if an `EventSearchOrder` is available.
Return	`boolean`		`true` if an event search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getEventSearchOrder
Description	Gets the search order for an event.
Return	`osid.calendaring.EventSearchOrder`		the event search order
Errors	UNIMPLEMENTED		`supportsEventSearchOrder() is false`
Compliance	`optional`		This method must be implemented if `supportsEventSearchOrder()` is true.
Method	orderByCyclicEvent
Description	Orders the results by cyclic event.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsCyclicEventSearchOrder
Description	Tests if a cyclic event search order is available.
Return	`boolean`		`true` if a cyclic event search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCyclicEventSearchOrder
Description	Gets the cyclic event search order.
Return	`osid.calendaring.cycle.CyclicEventSearchOrder`		the cyclic event search order
Errors	ILLEGAL_STATE		`supportsCyclicEventSearchOrder()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	orderByTimePeriod
Description	Orders the results by time period.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsTimePeriodSearchOrder
Description	Tests if a time period search order is available.
Return	`boolean`		`true` if a time period search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getTimePeriodSearchOrder
Description	Gets the time period search order.
Return	`osid.calendaring.TimePeriodSearchOrder`		the time period search order
Errors	ILLEGAL_STATE		`supportsTimePeriodSearchOrder()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	orderByCyclicTimePeriod
Description	Orders the results by cyclic time period.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsCyclicTimePeriodSearchOrder
Description	Tests if a cyclic time period search order is available.
Return	`boolean`		`true` if a cyclic time period search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCyclicTimePeriodSearchOrder
Description	Gets the cyclic time period search order.
Return	`osid.calendaring.cycle.CyclicTimePeriodSearchOrder`		the cyclic time period search order
Errors	ILLEGAL_STATE		`supportsCyclicTimePeriodSearchOrder()` is `false`
Compliance	`mandatory`		This method must be implemented.