public interface PostSearchOrder extends OsidObjectSearchOrder
An interface for specifying the ordering of search results.
Modifier and Type | Method and Description |
---|---|
ResourceSearchOrder |
getPosterSearchOrder()
Gets the poster order interface.
|
AgentSearchOrder |
getPostingAgentSearchOrder()
Gets the posting agent search order interface.
|
PostSearchOrderRecord |
getPostSearchOrderRecord(Type postRecordType)
Gets the post search record order corresponding to the given post
record Type.
|
void |
orderByPoster(SearchOrderStyle style)
Specifies a preference for ordering the result set by the poster.
|
void |
orderByPostingAgent(SearchOrderStyle style)
Specifies a preference for ordering the result set by the posting
agent.
|
void |
orderBySubjectLine(SearchOrderStyle style)
Specifies a preference for ordering the result set by the subject.
|
void |
orderByText(SearchOrderStyle style)
Specifies a preference for ordering the result set by the text.
|
void |
orderByTimestamp(SearchOrderStyle style)
Specifies a preference for ordering the result set by the timestamp.
|
boolean |
supportsPosterSearchOrder()
Tests if a resource order interface is available.
|
boolean |
supportsPostingAgentSearchOrder()
Tests if a posting agent order interface is available.
|
orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic
orderById
getRecordTypes, hasRecordType
void orderByTimestamp(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByPoster(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsPosterSearchOrder()
true
if a poster order interface is available,
false
otherwisemandatory
- This method must be implemented. ResourceSearchOrder getPosterSearchOrder()
UnimplementedException
-
supportsPosterSearchOrder()
is false
optional
- This method must be implemented if
supportsPosterSearchOrder()
is true.
void orderByPostingAgent(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsPostingAgentSearchOrder()
true
if a posting agent order interface is
available, false
otherwisemandatory
- This method must be implemented. AgentSearchOrder getPostingAgentSearchOrder()
UnimplementedException
-
supportsPostingAgentSearchOrder()
is false
optional
- This method must be implemented if
supportsPostingAgentSearchOrder()
is true.
void orderBySubjectLine(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByText(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. PostSearchOrderRecord getPostSearchOrderRecord(Type postRecordType) throws OperationFailedException
postRecordType
- a post record typeNullArgumentException
- postRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(postRecordType)
is false
mandatory
- This method must be implemented.