public interface PostEntrySearchOrder extends OsidObjectSearchOrder, OsidSubjugateableSearchOrder
An interface for specifying the ordering of search results.
Modifier and Type | Method and Description |
---|---|
AccountSearchOrder |
getAccountSearchOrder()
Gets the account order.
|
ActivitySearchOrder |
getActivitySearchOrder()
Gets the activity search order.
|
PostEntrySearchOrderRecord |
getPostEntrySearchOrderRecord(Type postEntryRecordType)
Gets the post entry search order record corresponding to the given
post entry record
Type. |
PostSearchOrder |
getPostSearchOrder()
Gets the post order.
|
void |
orderByAccount(SearchOrderStyle style)
Specifies a preference for ordering the result set by account.
|
void |
orderByActivity(SearchOrderStyle style)
Specifies a preference for ordering the result set by activity.
|
void |
orderByAmount(SearchOrderStyle style)
Specifies a preference for ordering the result set by the amount.
|
void |
orderByDebit(SearchOrderStyle style)
Specifies a preference for ordering the result set by the debit flag.
|
void |
orderByPost(SearchOrderStyle style)
Specifies a preference for ordering the result set by post.
|
boolean |
supportsAccountSearchOrder()
Tests if an account search order is available.
|
boolean |
supportsActivitySearchOrder()
Tests if an activity search order is available.
|
boolean |
supportsPostSearchOrder()
Tests if a post search order is available.
|
orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic
orderById
getRecordTypes, hasRecordType
void orderByPost(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsPostSearchOrder()
true
if a post search order is available,
false
otherwisemandatory
- This method must be implemented. PostSearchOrder getPostSearchOrder()
UnimplementedException
-
supportsPostSearchOrder()
is false
optional
- This method must be implemented if
supportsPostSearchOrder()
is true.
void orderByAccount(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsAccountSearchOrder()
true
if an search account order is available,
false
otherwisemandatory
- This method must be implemented. AccountSearchOrder getAccountSearchOrder()
UnimplementedException
-
supportsAccountSearchOrder()
is false
optional
- This method must be implemented if
supportsAccountSearchOrder()
is true.
void orderByActivity(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsActivitySearchOrder()
true
if an activity search order is available,
false
otherwisemandatory
- This method must be implemented. ActivitySearchOrder getActivitySearchOrder()
UnimplementedException
-
supportsActivitySearchOrder()
is false
optional
- This method must be implemented if
supportsActivitySearchOrder()
is true.
void orderByAmount(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByDebit(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. PostEntrySearchOrderRecord getPostEntrySearchOrderRecord(Type postEntryRecordType) throws OperationFailedException
Type.
Multiple retrievals return the
same underlying object.postEntryRecordType
- a post entry record typeNullArgumentException
- postEntryRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(postEntryRecordType)
is false
mandatory
- This method must be implemented.