org.osid.filing

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

Methods

Modifier and Type	Method and 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 org.osid.OsidObjectSearchOrder

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

Methods inherited from interface org.osid.OsidIdentifiableSearchOrder

orderById

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Method Detail

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 supportsOwnerSearchOrder() is 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.