Class AbstractOsidRuleApplicatorSearchOrder

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

net.okapia.osid.jamocha.spi.AbstractOsidEnablerSearchOrder

net.okapia.osid.jamocha.spi.AbstractOsidRuleApplicatorSearchOrder

All Implemented Interfaces:

Extensible, OsidBrowsableSearchOrder, OsidEnablerSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidOperableSearchOrder, OsidRuleApplicatorSearchOrder, OsidRuleSearchOrder, OsidSearchOrder, OsidTemporalSearchOrder, Suppliable

Direct Known Subclasses:

AbstractInstructionSearchOrder

public abstract class AbstractOsidRuleApplicatorSearchOrder
extends AbstractOsidEnablerSearchOrder
implements OsidRuleApplicatorSearchOrder

Defines a simple OsidRuleApplicatorSearchOrder to extend.

Nested Class Summary

Nested classes/interfaces inherited from class AbstractOsidEnablerSearchOrder

AbstractOsidEnablerSearchOrder.OsidTemporalSearchOrder

Modifier and Type	Class	Description
protected class	AbstractOsidEnablerSearchOrder.OsidTemporalSearchOrder	Composed OsidTemporalSearchOrder.

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

Constructor	Description
AbstractOsidRuleApplicatorSearchOrder()	Constructs a new AbstractOsidRuleApplicatorSearchOrder.

Method Summary

Modifier and Type	Method	Description
ResourceSearchOrder	getResourceSearchOrder()	Gets the resource order.
void	orderByResource(SearchOrderStyle style)	Specifies a preference for ordering the result set by the resource.
boolean	supportsResourceSearchOrder()	Tests if a resource order is available.

Methods inherited from class AbstractOsidEnablerSearchOrder

getCyclicEventSearchOrder, getCyclicTimePeriodSearchOrder, getEventSearchOrder, getScheduleSearchOrder, getTimePeriodSearchOrder, orderByCyclicEvent, orderByCyclicTimePeriod, orderByEffective, orderByEndDate, orderByEvent, orderByRequirement, orderBySchedule, orderByStartDate, orderByTimePeriod, supportsCyclicEventSearchOrder, supportsCyclicTimePeriodSearchOrder, supportsEventSearchOrder, supportsScheduleSearchOrder, supportsTimePeriodSearchOrder

Modifier and Type	Method	Description
CyclicEventSearchOrder	getCyclicEventSearchOrder()	Gets the cyclic event search order.
CyclicTimePeriodSearchOrder	getCyclicTimePeriodSearchOrder()	Gets the cyclic time period search order.
EventSearchOrder	getEventSearchOrder()	Gets the search order for an event.
ScheduleSearchOrder	getScheduleSearchOrder()	Gets the search order for a schedule.
TimePeriodSearchOrder	getTimePeriodSearchOrder()	Gets the search order for a time period.
void	orderByCyclicEvent(SearchOrderStyle style)	Orders the results by cyclic event.
void	orderByCyclicTimePeriod(SearchOrderStyle style)	Orders the results by cyclic time period.
void	orderByEffective(SearchOrderStyle style)	Specifies a preference for ordering the result set by the effective status.
void	orderByEndDate(SearchOrderStyle style)	Specifies a preference for ordering the result set by the end date.
void	orderByEvent(SearchOrderStyle style)	Specifies a preference for ordering the results by the associated event.
void	orderByRequirement(SearchOrderStyle style)	Specifies a preference for ordering the results by the requirement status.
void	orderBySchedule(SearchOrderStyle style)	Specifies a preference for ordering the results by the associated schedule.
void	orderByStartDate(SearchOrderStyle style)	Specifies a preference for ordering the result set by the start date.
void	orderByTimePeriod(SearchOrderStyle style)	Specifies a preference for ordering the results by the associated time period.
boolean	supportsCyclicEventSearchOrder()	Tests if a cyclic event search order is available.
boolean	supportsCyclicTimePeriodSearchOrder()	Tests if a cyclic time period search order is available.
boolean	supportsEventSearchOrder()	Tests if an EventSearchOrder is available.
boolean	supportsScheduleSearchOrder()	Tests if a ScheduleSearchOrder is available.
boolean	supportsTimePeriodSearchOrder()	Tests if a TimePeriodSearchOrder is available.

Methods inherited from class AbstractOsidRuleSearchOrder

getRuleSearchOrder, orderByRule, supportsRuleSearchOrder

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

AbstractOsidRuleApplicatorSearchOrder

public AbstractOsidRuleApplicatorSearchOrder()

Constructs a new AbstractOsidRuleApplicatorSearchOrder.

Method Details

orderByResource

@OSID
public void orderByResource(SearchOrderStyle style)

Specifies a preference for ordering the result set by the resource.

Specified by:

orderByResource in interface OsidRuleApplicatorSearchOrder

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

supportsResourceSearchOrder

@OSID
public boolean supportsResourceSearchOrder()

Tests if a resource order is available.

Specified by:

supportsResourceSearchOrder in interface OsidRuleApplicatorSearchOrder

Returns:

true if a resource order is available, false otherwise

getResourceSearchOrder

@OSID
public ResourceSearchOrder getResourceSearchOrder()

Gets the resource order.

Specified by:

getResourceSearchOrder in interface OsidRuleApplicatorSearchOrder

Returns:

the resource search order

Throws:

UnimplementedException - supportsResourceSearchOrder() is false