Class AbstractOsidGovernatorSearchOrder

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

All Implemented Interfaces:

Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidGovernatorSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidOperableSearchOrder, OsidSearchOrder, OsidSourceableSearchOrder, Suppliable

Direct Known Subclasses:

AbstractAuctionSearchOrder, AbstractAuditSearchOrder, AbstractBallotSearchOrder, AbstractBrokerSearchOrder, AbstractCompositionSearchOrder, AbstractConvocationSearchOrder, AbstractDispatchSearchOrder, AbstractIssueSearchOrder, AbstractJobSearchOrder, AbstractPoolSearchOrder, AbstractProcessSearchOrder, AbstractQueueSearchOrder, AbstractQueueSearchOrder, AbstractRaceSearchOrder

public abstract class AbstractOsidGovernatorSearchOrder
extends AbstractOperableOsidObjectSearchOrder
implements OsidGovernatorSearchOrder

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	AbstractOsidGovernatorSearchOrder.OsidSourceableSearchOrder	Defines an OsidSourceableSearchOrder.

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

Method Summary

Modifier and Type	Method	Description
ResourceSearchOrder	getProviderSearchOrder()	Gets the search order interface for a provider.
void	orderByProvider(SearchOrderStyle style)	Specifies a preference for ordering the results by provider.
boolean	supportsProviderSearchOrder()	Tests if a ProviderSearchOrder interface 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

AbstractOsidGovernatorSearchOrder

public AbstractOsidGovernatorSearchOrder()

Constructs a new AbstractOsidGovernatorSearchOrder.

Method Details

orderByProvider

@OSID
public void orderByProvider(SearchOrderStyle style)

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:

orderByProvider in interface OsidSourceableSearchOrder

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

supportsProviderSearchOrder

@OSID
public boolean supportsProviderSearchOrder()

Tests if a ProviderSearchOrder interface is available.

Specified by:

supportsProviderSearchOrder in interface OsidSourceableSearchOrder

Returns:

true if a provider search order interface is available, false otherwise

getProviderSearchOrder

@OSID
public ResourceSearchOrder getProviderSearchOrder()

Gets the search order interface for a provider.

Specified by:

getProviderSearchOrder in interface OsidSourceableSearchOrder

Returns:

the provider search order interface

Throws:

UnimplementedException - supportsProviderSearchOrder() is false supportsProviderSearchOrder()} is true.