Interface DirectoryEntrySearchOrder

All Superinterfaces:

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

All Known Subinterfaces:

DirectorySearchOrder, FileSearchOrder

public interface DirectoryEntrySearchOrder
extends OsidObjectSearchOrder

An interface for specifying the order of search results.

Method Summary

Modifier and Type	Method	Description
AgentSearchOrder	getOwnerSearchOrder()	Gets an agent search order interface.
void	orderByCreatedTime(SearchOrderStyle style)	Specifies a preference for ordering the result set by the entry creation time.
void	orderByLastAccessTime(SearchOrderStyle style)	Specifies a preference for ordering the result set by the entry last access time.
void	orderByModifiedTime(SearchOrderStyle style)	Specifies a preference for ordering the result set by the entry modification time.
void	orderByName(SearchOrderStyle style)	Specifies a preference for ordering the result set by the entry name.
void	orderByOwner(SearchOrderStyle style)	Specifies a preference for ordering the result set by the entry owner.
void	orderByPath(SearchOrderStyle style)	Specifies a preference for ordering the result set by the entry path.
boolean	supportsOwnerSearchOrder()	Tests if an agent search order is available.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidIdentifiableSearchOrder

orderById

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

Methods inherited from interface OsidObjectSearchOrder

orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic

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

Method Details

orderByName

void orderByName(SearchOrderStyle style)

Specifies a preference for ordering the result set by the entry name.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByPath

void orderByPath(SearchOrderStyle style)

Specifies a preference for ordering the result set by the entry path.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByOwner

void orderByOwner(SearchOrderStyle style)

Specifies a preference for ordering the result set by the entry owner.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsOwnerSearchOrder

boolean supportsOwnerSearchOrder()

Tests if an agent search order is available.

Returns:

true if an agent search order interface is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getOwnerSearchOrder

AgentSearchOrder getOwnerSearchOrder()

Gets an agent search order interface.

Returns:

an agent search order interface

Throws:

UnimplementedException - supportsOwnerSearchOrder() is false

Compliance:

optional - This method must be implemented if {@code supportsOwnerSearchOrder()} is {@code true} .

orderByCreatedTime

void orderByCreatedTime(SearchOrderStyle style)

Specifies a preference for ordering the result set by the entry creation time.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByModifiedTime

void orderByModifiedTime(SearchOrderStyle style)

Specifies a preference for ordering the result set by the entry modification time.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByLastAccessTime

void orderByLastAccessTime(SearchOrderStyle style)

Specifies a preference for ordering the result set by the entry last access time.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.