Class AbstractOsidSourceableSearchOrder
java.lang.Object
net.okapia.osid.jamocha.spi.AbstractOsidSearchOrder
net.okapia.osid.jamocha.spi.AbstractOsidSourceableSearchOrder
- All Implemented Interfaces:
OsidSearchOrder, OsidSourceableSearchOrder, Suppliable
- Direct Known Subclasses:
AbstractOsidGovernatorSearchOrder.OsidSourceableSearchOrder, AbstractSourceableOsidObjectSearchOrder.OsidSourceableSearchOrder
public abstract class AbstractOsidSourceableSearchOrder
extends AbstractOsidSearchOrder
implements OsidSourceableSearchOrder
Defines a simple OsidSearchOrder to extend. This class
does nothing.
-
Constructor Summary
ConstructorsConstructorDescriptionConstructs a newAbstractOsidSourceableSearchOrder. -
Method Summary
Modifier and TypeMethodDescriptionGets the search order interface for a provider.voidorderByProvider(SearchOrderStyle style) Specifies a preference for ordering the results by provider.booleanTests if aProviderSearchOrderinterface is available.
-
Constructor Details
-
AbstractOsidSourceableSearchOrder
public AbstractOsidSourceableSearchOrder()Constructs a newAbstractOsidSourceableSearchOrder.
-
-
Method Details
-
orderByProvider
Specifies a preference for ordering the results by provider. The element of the provider to order is not specified but may be managed through the provider ordering interface.- Specified by:
orderByProviderin interfaceOsidSourceableSearchOrder- Parameters:
style- search order style- Throws:
NullArgumentException-styleisnull
-
supportsProviderSearchOrder
Tests if aProviderSearchOrderinterface is available.- Specified by:
supportsProviderSearchOrderin interfaceOsidSourceableSearchOrder- Returns:
trueif a provider search order interface is available,falseotherwise
-
getProviderSearchOrder
Gets the search order interface for a provider.- Specified by:
getProviderSearchOrderin interfaceOsidSourceableSearchOrder- Returns:
- the provider search order interface
- Throws:
UnimplementedException-supportsProviderSearchOrder()isfalsesupportsProviderSearchOrder()} istrue.
-