Interface | osid.subscription.DispatchSmartPublisherSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session manages queries and sequencing to create
"smart" dynamic catalogs. A This | ||
Method | getPublisherId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Publisher Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getPublisher | ||
Description |
Gets the | ||
Return | osid.subscription.Publisher | the Publisher associated with this session | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageSmartPublishers | ||
Description |
Tests if this user can manage smart publishers. A
return of true does not guarantee successful
authorization. A return of false indicates that it is
known methods in this session will result in a | ||
Return | boolean | false if smart publisher management is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getDispatchQuery | ||
Description |
Gets a dispatch query. | ||
Return | osid.subscription.DispatchQuery | the dispatch query | |
Compliance | mandatory | This method must be implemented. | |
Method | getDispatchSearchOrder | ||
Description |
Gets a dispatch search order. | ||
Return | osid.subscription.DispatchSearchOrder | the dispatch search order | |
Compliance | mandatory | This method must be implemented. | |
Method | applyDispatchQuery | ||
Description |
Applies a dispatch query to this publisher. | ||
Parameters | osid.subscription.DispatchQuery | dispatchQuery | the dispatch query |
Errors | NULL_ARGUMENT | dispatchQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | dispatchQuery not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | inspectDispatchQuery | ||
Description |
Gets a dispatch query inspector for this publisher. | ||
Return | osid.subscription.DispatchQueryInspector | the dispatch query inspector | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | applyDispatchSequencing | ||
Description |
Applies a dispatch search order to this publisher. | ||
Parameters | osid.subscription.DispatchSearchOrder | dispatchSearchOrder | the dispatch search order |
Errors | NULL_ARGUMENT | dispatchSearchOrder is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | dispatchSearchOrder not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getDispatchQueryFromInspector | ||
Description |
Gets a dispatch query from an inspector. | ||
Parameters | osid.subscription.DispatchQueryInspector | dispatchQueryInspector | a query inspector |
Return | osid.subscription.DispatchQuery | the dispatch query | |
Errors | NULL_ARGUMENT | dispatchQueryInspector is null | |
UNSUPPORTED | dispatchQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |