org.osid.logging

Interface LogEntrySearchOrder

All Superinterfaces:

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

public interface LogEntrySearchOrder
extends OsidObjectSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
AgentSearchOrder	getAgentSearchOrder() Gets the agent order.
LogEntrySearchOrderRecord	getLogEntrySearchOrderRecord(Type logEntryRecordType) Gets the log entry search order record corresponding to the given log entry record Type.
ResourceSearchOrder	getResourceSearchOrder() Gets the resource order.
void	orderByAgent(SearchOrderStyle style) Specifies a preference for ordering log entries by agent.
void	orderByPriority(SearchOrderStyle style) Specifies a preference for ordering log entris by priority type.
void	orderByResource(SearchOrderStyle style) Specifies a preference for ordering log entries by resource.
void	orderByTimestamp(SearchOrderStyle style) Specifies a preference for ordering log entries by time.
boolean	supportsAgentSearchOrder() Tests if an agent order is available.
boolean	supportsResourceSearchOrder() Tests if a resource 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

orderByPriority

void orderByPriority(SearchOrderStyle style)

Specifies a preference for ordering log entris by priority type.

Parameters:

style - search otrder style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByTimestamp

void orderByTimestamp(SearchOrderStyle style)

Specifies a preference for ordering log entries by time.

Parameters:

style - search otrder style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByResource

void orderByResource(SearchOrderStyle style)

Specifies a preference for ordering log entries by resource.

Parameters:

style - search otrder style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsResourceSearchOrder

boolean supportsResourceSearchOrder()

Tests if a resource order is available.

Returns:

true if a resource order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getResourceSearchOrder

ResourceSearchOrder getResourceSearchOrder()

Gets the resource order.

Returns:

the resource search order

Throws:

UnimplementedException - supportsResourceSearchOrder() is false

Compliance:

optional - This method must be implemented if supportsResourceSearchOrder() is true.

orderByAgent

void orderByAgent(SearchOrderStyle style)

Specifies a preference for ordering log entries by agent.

Parameters:

style - search otrder style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsAgentSearchOrder

boolean supportsAgentSearchOrder()

Tests if an agent order is available.

Returns:

true if an agent order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAgentSearchOrder

AgentSearchOrder getAgentSearchOrder()

Gets the agent order.

Returns:

the agent search order

Throws:

UnimplementedException - supportsAgentSearchOrder() is false

Compliance:

optional - This method must be implemented if supportsAgentSearchOrder() is true.

getLogEntrySearchOrderRecord

LogEntrySearchOrderRecord getLogEntrySearchOrderRecord(Type logEntryRecordType)
                                                       throws OperationFailedException

Gets the log entry search order record corresponding to the given log entry record Type. Multiple retrievals return the same underlying object.

Parameters:

logEntryRecordType - a log entry record type

Returns:

the log entry search order record

Throws:

NullArgumentException - logEntryRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(logEntryRecordType) is false

Compliance:

mandatory - This method must be implemented.