| Interface | osid.blogging.EntrySearchOrder | ||
|---|---|---|---|
| Implements | osid.OsidObjectSearchOrder | ||
osid.OsidSourceableSearchOrder | |||
| Description | 
                 An interface for specifying the ordering of search results.  | ||
| Method | orderByTimestamp | ||
| Description | 
                     Specifies a preference for ordering entries by time.  | ||
| Parameters | osid.SearchOrderStyle | style | search order style | 
| Errors | NULL_ARGUMENT |  style  is  null   |                 |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByPoster | ||
| Description | 
                     Specifies a preference for ordering entries by the poster.  | ||
| Parameters | osid.SearchOrderStyle | style | search order style | 
| Errors | NULL_ARGUMENT |  style  is  null   |                 |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsPosterSearchOrder | ||
| Description | 
                     Tests if a resource order interface is available.  | ||
| Return | boolean |  true  if a resource order interface is available,  
false  otherwise  | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getPosterSearchOrder | ||
| Description | 
                     Gets the poster resource search order interface.  | ||
| Return | osid.resource.ResourceSearchOrder | the resource search order interface | |
| Errors | UNIMPLEMENTED |  supportsResourceSearchOrder()  is  false   |                 |
| Compliance | optional | This method must be implemented if  supportsResourceSearchOrder() 
 is  true.   | |
| Method | orderByPostingAgent | ||
| Description | 
                     Specifies a preference for ordering entries by the posting agent.  | ||
| Parameters | osid.SearchOrderStyle | style | search order style | 
| Errors | NULL_ARGUMENT |  style  is  null   |                 |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsPostingAgentSearchOrder | ||
| Description | 
                     Tests if an agent order interface is available.  | ||
| Return | boolean |  true  if an agent order interface is available,  false 
 otherwise  | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getPostingAgentSearchOrder | ||
| Description | 
                     Gets the posting agent order interface.  | ||
| Return | osid.authentication.AgentSearchOrder | the agent search order interface | |
| Errors | UNIMPLEMENTED |  supportsPostingAgentSearchOrder()  is  false   |                 |
| Compliance | optional | This method must be implemented if  supportsPostingAgentSearchOrder() 
 is  true.   | |
| Method | orderBySubjectLine | ||
| Description | 
                     Specifies a preference for ordering entries by subject line.  | ||
| Parameters | osid.SearchOrderStyle | style | search order style | 
| Errors | NULL_ARGUMENT |  style  is  null   |                 |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderBySummary | ||
| Description | 
                     Specifies a preference for ordering entries by summary.  | ||
| Parameters | osid.SearchOrderStyle | style | search order style | 
| Errors | NULL_ARGUMENT |  style  is  null   |                 |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByText | ||
| Description | 
                     Specifies a preference for ordering entries by text.  | ||
| Parameters | osid.SearchOrderStyle | style | search order style | 
| Errors | NULL_ARGUMENT |  style  is  null   |                 |
| Compliance | mandatory | This method must be implemented. | |
| Method | getEntrySearchOrderRecord | ||
| Description | 
                     Gets the entry search order record interface 
                    corresponding to the given entry record   | ||
| Parameters | osid.type.Type | entryRecordType | an entry record type | 
| Return | osid.blogging.records.EntrySearchOrderRecord | the entry search order record | |
| Errors | NULL_ARGUMENT |  entryRecordType  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure occurred | ||
| UNSUPPORTED |  hasRecordType(entryRecordType)  is  false   |                 ||
| Compliance | mandatory | This method must be implemented. | |