Class AbstractTemporalOsidObjectSearchOrder

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

All Implemented Interfaces:

Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidSearchOrder, OsidTemporalSearchOrder, Suppliable

Direct Known Subclasses:

AbstractActivitySearchOrder, AbstractBuildingSearchOrder, AbstractCustomerSearchOrder, AbstractEventSearchOrder, AbstractFloorSearchOrder, AbstractOrganizationSearchOrder, AbstractOsidRelationshipSearchOrder, AbstractPayerSearchOrder, AbstractPositionSearchOrder, AbstractProjectSearchOrder, AbstractRenovationSearchOrder, AbstractResultSearchOrder, AbstractRoomSearchOrder, AbstractTodoSearchOrder

public abstract class AbstractTemporalOsidObjectSearchOrder
extends AbstractOsidObjectSearchOrder
implements OsidObjectSearchOrder, OsidTemporalSearchOrder

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

Nested Class Summary

Nested Classes

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

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
AbstractTemporalOsidObjectSearchOrder()	Constructs a new AbstractTemporalOsidObjectSearchOrder.

Method Summary

Modifier and Type	Method	Description
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	orderByStartDate(SearchOrderStyle style)	Specifies a preference for ordering the result set by the start date.

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

AbstractTemporalOsidObjectSearchOrder

public AbstractTemporalOsidObjectSearchOrder()

Constructs a new AbstractTemporalOsidObjectSearchOrder.

Method Details

orderByEffective

@OSID
public void orderByEffective(SearchOrderStyle style)

Specifies a preference for ordering the result set by the effective status.

Specified by:

orderByEffective in interface OsidTemporalSearchOrder

Parameters:

style - the search order style

Throws:

NullArgumentException - style is null

orderByStartDate

@OSID
public void orderByStartDate(SearchOrderStyle style)

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

Specified by:

orderByStartDate in interface OsidTemporalSearchOrder

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 OsidTemporalSearchOrder

Parameters:

style - the search order style

Throws:

NullArgumentException - style is null