OSID Specifications
blogging package
Version 3.1.0
blogging package
Version 3.1.0
| Interface | osid.blogging.BlogSearchSession | ||
|---|---|---|---|
| Implements | osid.blogging.BlogQuerySession | ||
| Used By | osid.blogging.BloggingManager | ||
osid.blogging.BloggingProxyManager | |||
| Description |
This session provides methods for searching among
getBlogsByQuery() is the basic search method and
returns a list of Blog objects.A more advanced
search may be performed with getBlogsBySearch()
.It accepts a BlogSearch in addition to the query
for the purpose of specifying additional options affecting the
entire search, such as ordering.
getBlogsBySearch() returns a
BlogSearchResults that can be used to access the
resulting BlogList or be used to perform a search
within the result set through BlogSearch.
Blogs may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
| Method | getBlogSearch | ||
| Description |
Gets a blog search. | ||
| Return | osid.blogging.BlogSearch | the blog search | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getBlogSearchOrder | ||
| Description |
Gets a blog search order. The
| ||
| Return | osid.blogging.BlogSearchOrder | the blog search order | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getBlogsBySearch | ||
| Description |
Gets the search results matching the given search query using the given search. | ||
| Parameters | osid.blogging.BlogQuery | blogQuery | the blog query |
osid.blogging.BlogSearch | blogSearch | the blog search | |
| Return | osid.blogging.BlogSearchResults | the search results | |
| Errors | NULL_ARGUMENT | blogQuery or blogSearch is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| UNSUPPORTED | blogQuery or blogSearch is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getBlogQueryFromInspector | ||
| Description |
Gets a blog query from an inspector. The inspector is
available from an | ||
| Parameters | osid.blogging.BlogQueryInspector | blogQueryInspector | a query inspector |
| Return | osid.blogging.BlogQuery | the blog query | |
| Errors | NULL_ARGUMENT | blogQueryInspector is null | |
| UNSUPPORTED | blogQueryInspector is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |