public interface LogEntrySearchOrder extends OsidObjectSearchOrder
An interface for specifying the ordering of search results.
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.
|
orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic
orderById
getRecordTypes, hasRecordType
void orderByPriority(SearchOrderStyle style)
style
- search otrder styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByTimestamp(SearchOrderStyle style)
style
- search otrder styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByResource(SearchOrderStyle style)
style
- search otrder styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsResourceSearchOrder()
true
if a resource order is available,
false
otherwisemandatory
- This method must be implemented. ResourceSearchOrder getResourceSearchOrder()
UnimplementedException
-
supportsResourceSearchOrder()
is false
optional
- This method must be implemented if
supportsResourceSearchOrder()
is true.
void orderByAgent(SearchOrderStyle style)
style
- search otrder styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsAgentSearchOrder()
true
if an agent order is available,
false
otherwisemandatory
- This method must be implemented. AgentSearchOrder getAgentSearchOrder()
UnimplementedException
-
supportsAgentSearchOrder()
is false
optional
- This method must be implemented if
supportsAgentSearchOrder()
is true.
LogEntrySearchOrderRecord getLogEntrySearchOrderRecord(Type logEntryRecordType) throws OperationFailedException
Type.
Multiple retrievals return the same
underlying object.logEntryRecordType
- a log entry record typeNullArgumentException
- logEntryRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(logEntryRecordType)
is false
mandatory
- This method must be implemented.