public interface JournalEntrySearchOrder extends OsidObjectSearchOrder, OsidSubjugateableSearchOrder
An interface for specifying the ordering of search results.
Modifier and Type | Method and Description |
---|---|
AgentSearchOrder |
getAgentSearchOrder()
Gets the agent order.
|
BranchSearchOrder |
getBranchSearchOrder()
Gets the branch search order.
|
JournalEntrySearchOrderRecord |
getJournalEntrySearchOrderRecord(Type journalEntryRecordType)
Gets the journal entry search order record corresponding to the given
journal entry record
Type. |
ResourceSearchOrder |
getResourceSearchOrder()
Gets the resource order.
|
void |
orderByAgent(SearchOrderStyle style)
Specifies a preference for ordering the result set by the agent.
|
void |
orderByBranch(SearchOrderStyle style)
Specifies a preference for ordering the result set by the branch.
|
void |
orderByResource(SearchOrderStyle style)
Specifies a preference for ordering the result set by the resource.
|
void |
orderBySource(SearchOrderStyle style)
Specifies a preference for ordering the result set by the source.
|
void |
orderByTimestamp(SearchOrderStyle style)
Specifies a preference for ordering the result set by the timestamp.
|
boolean |
supportsAgentSearchOrder()
Tests if an agent order is available.
|
boolean |
supportsBranchSearchOrder()
Tests if a branch search order is available.
|
boolean |
supportsResourceSearchOrder()
Tests if a resource order is available.
|
orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic
orderById
getRecordTypes, hasRecordType
void orderByBranch(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsBranchSearchOrder()
true
if a branch order is available,
false
otherwisemandatory
- This method must be implemented. BranchSearchOrder getBranchSearchOrder()
UnimplementedException
-
supportsBranchSearchOrder()
is false
optional
- This method must be implemented if
supportsBranchSearchOrder()
is true.
void orderBySource(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByTimestamp(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByResource(SearchOrderStyle style)
style
- search order 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
supportsAgentSearchOrder()
is true.
void orderByAgent(SearchOrderStyle style)
style
- search order 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.
JournalEntrySearchOrderRecord getJournalEntrySearchOrderRecord(Type journalEntryRecordType) throws OperationFailedException
Type.
Multiple retrievals return
the same underlying object.journalEntryRecordType
- a journal entry record typeNullArgumentException
- journalEntryRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(journalEntryRecordType)
is false
mandatory
- This method must be implemented.