Class AbstractOsidRuleSearchOrder

java.lang.Object

net.okapia.osid.jamocha.spi.AbstractOsidSearchOrder

net.okapia.osid.jamocha.spi.AbstractOsidIdentifiableSearchOrder

net.okapia.osid.jamocha.spi.AbstractOsidObjectSearchOrder

net.okapia.osid.jamocha.spi.AbstractOperableOsidObjectSearchOrder

net.okapia.osid.jamocha.spi.AbstractOsidRuleSearchOrder

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractAgendaSearchOrder, AbstractCheckSearchOrder, AbstractDemographicSearchOrder, AbstractFunctionSearchOrder, AbstractGradebookColumnSummarySearchOrder, AbstractInputSearchOrder, AbstractInquirySearchOrder, AbstractOffsetEventSearchOrder, AbstractOsidConstrainerSearchOrder, AbstractOsidEnablerSearchOrder, AbstractOsidProcessorSearchOrder, AbstractParameterSearchOrder, AbstractPriceSearchOrder, AbstractRecurringEventSearchOrder, AbstractRuleSearchOrder, AbstractSequenceRuleSearchOrder, AbstractSignalSearchOrder, AbstractSpeedZoneSearchOrder, AbstractStepSearchOrder, AbstractSupersedingEventSearchOrder, AbstractTodoProducerSearchOrder, AbstractTriggerSearchOrder

public abstract class AbstractOsidRuleSearchOrder
extends AbstractOperableOsidObjectSearchOrder
implements OsidRuleSearchOrder

Defines a simple OsidSearchOrder to extend. This class does nothing.

Nested Class Summary

Nested classes/interfaces inherited from class AbstractOperableOsidObjectSearchOrder

AbstractOperableOsidObjectSearchOrder.OsidOperableSearchOrder

Modifier and Type	Class	Description
protected class	AbstractOperableOsidObjectSearchOrder.OsidOperableSearchOrder	Composed OsidOperableSearchOrder.

Nested classes/interfaces inherited from class AbstractOsidObjectSearchOrder

AbstractOsidObjectSearchOrder.OsidBrowsableSearchOrder

Modifier and Type	Class	Description
protected class	AbstractOsidObjectSearchOrder.OsidBrowsableSearchOrder	Composed OsidBrowsableSearchOrder.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractOsidRuleSearchOrder()	Constructs a new AbstractOsidRuleSearchOrder.

Method Summary

Modifier and Type	Method	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 class AbstractOperableOsidObjectSearchOrder

orderByActive, orderByDisabled, orderByEnabled, orderByOperational

Modifier and Type	Method	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.

Methods inherited from class AbstractOsidObjectSearchOrder

addRecordType, getRecordTypes, hasRecordType, orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic

Modifier and Type	Method	Description
protected void	addRecordType(Type recordType)	Adds a record type.
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type.
void	orderByCreateTime(SearchOrderStyle style)	Orders by the timestamp of the first journal entry.
void	orderByCumulativeRating(Id bookId, SearchOrderStyle style)	Orders by the cumulative rating in a given Book.
void	orderByDescription(SearchOrderStyle style)	Specifies a preference for ordering the result set by the description.
void	orderByDisplayName(SearchOrderStyle style)	Specifies a preference for ordering the result set by the display name.
void	orderByGenusType(SearchOrderStyle style)	Specifies a preference for ordering the result set by the genus type.
void	orderByLastModifiedTime(SearchOrderStyle style)	Orders by the timestamp of the last journal entry.
void	orderByState(Id processId, SearchOrderStyle style)	Orders by the state in a given Process.
void	orderByStatistic(Id meterId, SearchOrderStyle style)	Orders by a statistic for a given Meter.

Methods inherited from class AbstractOsidIdentifiableSearchOrder

orderById

Modifier and Type	Method	Description
void	orderById(SearchOrderStyle style)	Specifies a preference for ordering the result set by the Id.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

AbstractOsidRuleSearchOrder

protected AbstractOsidRuleSearchOrder()

Constructs a new AbstractOsidRuleSearchOrder.

Method Details

orderByRule

@OSID
public 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.

Specified by:

orderByRule in interface OsidRuleSearchOrder

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

supportsRuleSearchOrder

@OSID
public boolean supportsRuleSearchOrder()

Tests if a RuleSearchOrder is available.

Specified by:

supportsRuleSearchOrder in interface OsidRuleSearchOrder

Returns:

true if a rule search order is available, false otherwise

getRuleSearchOrder

@OSID
public RuleSearchOrder getRuleSearchOrder()

Gets the search order for a rule.

Specified by:

getRuleSearchOrder in interface OsidRuleSearchOrder

Returns:

the rule search order

Throws:

UnimplementedException - supportsRuleSearchOrder() is false