| Interface | osid.blogging.EntrySmartBlogSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Description |
This session manages queries and sequencing to create
"smart" dynamic catalogs. An This | ||
| Method | getBlogId | ||
| Description |
Gets the | ||
| Return | osid.id.Id | the Blog Id associated with this session | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getBlog | ||
| Description |
Gets the | ||
| Return | osid.blogging.Blog | the Blog associated with this session | |
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | canManageSmartBlogs | ||
| Description |
Tests if this user can manage smart blogs. A return of
true does not guarantee successful authorization. A return
of false indicates that it is known all methods in this
session will result in a | ||
| Return | boolean | false if smart blog methods are not authorized, true
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getEntryQuery | ||
| Description |
Gets an entry query. | ||
| Return | osid.blogging.EntryQuery | the entry query | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getEntrySearchOrder | ||
| Description |
Gets an entry search order. | ||
| Return | osid.blogging.EntrySearchOrder | the entry search order | |
| Compliance | mandatory | This method must be implemented. | |
| Method | applyEntryQuery | ||
| Description |
Applies an entry query to this blog. | ||
| Parameters | osid.blogging.EntryQuery | entryQuery | the entry query |
| Errors | NULL_ARGUMENT | entryQuery is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure occurred | ||
| UNSUPPORTED | entryQuery not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | inspectEntryQuery | ||
| Description |
Gets an entry query inspector for this blog. | ||
| Return | osid.blogging.EntryQueryInspector | the entry query inspector | |
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure occurred | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | applyEntrySequencing | ||
| Description |
Applies an entry search order to this blog. | ||
| Parameters | osid.blogging.EntrySearchOrder | entrySearchOrder | the entry search order |
| Errors | NULL_ARGUMENT | entrySearchOrder is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure occurred | ||
| UNSUPPORTED | entrySearchOrder not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getEntryQueryFromInspector | ||
| Description |
Gets an entry query from an inspector. | ||
| Parameters | osid.blogging.EntryQueryInspector | entryQueryInspector | a query inspector |
| Return | osid.blogging.EntryQuery | the entry query | |
| Errors | NULL_ARGUMENT | entryQueryInspector is null | |
| UNSUPPORTED | entryQueryInspector is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |