Interface | osid.subscription.DispatchPublisherSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to retrieve This lookup session defines several views:
| ||
Method | canLookupDispatchPublisherMappings | ||
Description |
Tests if this user can perform lookups of
dispatch/publisher mappings. A return of true does not
guarantee successful authorization. A return of false
indicates that it is known lookup methods in this session
will result in a | ||
Return | boolean | false if looking up mappings is not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativePublisherView | ||
Description |
The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | usePlenaryPublisherView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getDispatchIdsByPublisher | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | publisherId | Id of a Publisher |
Return | osid.id.IdList | list of related dispatch Ids | |
Errors | NOT_FOUND | publisherId is not found | |
NULL_ARGUMENT | publisherId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getDispatchesByPublisher | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | publisherId | Id of a Publisher |
Return | osid.subscription.DispatchList | list of related dispatches | |
Errors | NOT_FOUND | publisherId is not found | |
NULL_ARGUMENT | publisherId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getDispatchIdsByPublishers | ||
Description |
Gets the list of | ||
Parameters | osid.id.IdList | publisherIds | list of publisher Ids |
Return | osid.id.IdList | list of dispatch Ids | |
Errors | NULL_ARGUMENT | publisherIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getDispatchesByPublishers | ||
Description |
Gets the list of | ||
Parameters | osid.id.IdList | publisherIds | list of publisher Ids |
Return | osid.subscription.DispatchList | list of dispatches | |
Errors | NULL_ARGUMENT | publisherIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getPublisherIdsByDispatch | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | dispatchId | Id of a Dispatch |
Return | osid.id.IdList | list of publisher Ids | |
Errors | NOT_FOUND | dispatchId is not found | |
NULL_ARGUMENT | dispatchId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getPublishersByDispatch | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | dispatchId | Id of a Dispatch |
Return | osid.subscription.PublisherList | list of publishers | |
Errors | NOT_FOUND | dispatchId is not found | |
NULL_ARGUMENT | dispatchId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |