Class AbstractOsidCompendiumSearchOrder

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.AbstractOsidCompendiumSearchOrder

All Implemented Interfaces:

Extensible, OsidBrowsableSearchOrder, OsidCompendiumSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidOperableSearchOrder, OsidSearchOrder, OsidSubjugateableSearchOrder, Suppliable

Direct Known Subclasses:

AbstractStatisticSearchOrder, AbstractSummarySearchOrder

public abstract class AbstractOsidCompendiumSearchOrder
extends AbstractOperableOsidObjectSearchOrder
implements OsidCompendiumSearchOrder

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

Constructor	Description
AbstractOsidCompendiumSearchOrder()	Constructs a new AbstractOsidCompendiumSearchOrder.

Method Summary

Modifier and Type	Method	Description
void	orderByEndDate(SearchOrderStyle style)	Specifies a preference for ordering the result set by the end date.
void	orderByExtrapolated(SearchOrderStyle style)	Specifies a preference for ordering the result set by extrapolated results.
void	orderByInterpolated(SearchOrderStyle style)	Specifies a preference for ordering the result set by interpolated results.
void	orderByStartDate(SearchOrderStyle style)	Specifies a preference for ordering the result set by the start date.

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

AbstractOsidCompendiumSearchOrder

public AbstractOsidCompendiumSearchOrder()

Constructs a new AbstractOsidCompendiumSearchOrder.

Method Details

orderByStartDate

@OSID
public void orderByStartDate(SearchOrderStyle style)

Specifies a preference for ordering the result set by the start date.

Specified by:

orderByStartDate in interface OsidCompendiumSearchOrder

Parameters:

style - the search order style

Throws:

NullArgumentException - style is null

orderByEndDate

@OSID
public void orderByEndDate(SearchOrderStyle style)

Specifies a preference for ordering the result set by the end date.

Specified by:

orderByEndDate in interface OsidCompendiumSearchOrder

Parameters:

style - the search order style

Throws:

NullArgumentException - style is null

orderByInterpolated

@OSID
public void orderByInterpolated(SearchOrderStyle style)

Specifies a preference for ordering the result set by interpolated results.

Specified by:

orderByInterpolated in interface OsidCompendiumSearchOrder

Parameters:

style - the search order style

Throws:

NullArgumentException - style is null

orderByExtrapolated

@OSID
public void orderByExtrapolated(SearchOrderStyle style)

Specifies a preference for ordering the result set by extrapolated results.

Specified by:

orderByExtrapolated in interface OsidCompendiumSearchOrder

Parameters:

style - the search order style

Throws:

NullArgumentException - style is null