Interface | osid.subscription.DispatchLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods for retrieving This session defines views that offer differing behaviors when retrieving multiple objects.
| ||
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 | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canLookupDispatches | ||
Description |
Tests if this user can perform | ||
Return | boolean | false if lookup methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeDispatchView | ||
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 | usePlenaryDispatchView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useFederatedPublisherView | ||
Description |
Federates the view for methods in this session. A federated view will include dispatches in publishers which are children of this publisher in the publisher hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedPublisherView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts retrievals to this publisher only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useActiveDispatchView | ||
Description |
Only active dispatches are returned by methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useAnyStatusDispatchView | ||
Description |
All active and inactive dispatches are returned by methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getDispatch | ||
Description |
Gets the In active mode, dispatches are returned that are currently active. In any status mode, active and inactive dispatches are returned. | ||
Parameters | osid.id.Id | dispatchId | Id of the Dispatch |
Return | osid.subscription.Dispatch | the dispatch | |
Errors | NOT_FOUND | dispatchId not found | |
NULL_ARGUMENT | dispatchId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getDispatchesByIds | ||
Description |
Gets a In active mode, dispatches are returned that are currently active. In any status mode, active and inactive dispatches are returned. | ||
Parameters | osid.id.IdList | dispatchIds | the list of Ids to retrieve |
Return | osid.subscription.DispatchList | the returned Dispatch list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | dispatchIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getDispatchesByGenusType | ||
Description |
Gets a In active mode, dispatches are returned that are currently active. In any status mode, active and inactive dispatches are returned. | ||
Parameters | osid.type.Type | dispatchGenusType | a dispatch genus type |
Return | osid.subscription.DispatchList | the returned Dispatch list | |
Errors | NULL_ARGUMENT | dispatchGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getDispatchesByParentGenusType | ||
Description |
Gets a In active mode, dispatches are returned that are currently active. In any status mode, active and inactive dispatches are returned. | ||
Parameters | osid.type.Type | dispatchGenusType | a dispatch genus type |
Return | osid.subscription.DispatchList | the returned Dispatch list | |
Errors | NULL_ARGUMENT | dispatchGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getDispatchesByRecordType | ||
Description |
Gets a In active mode, dispatches are returned that are currently active. In any status mode, active and inactive dispatches are returned. | ||
Parameters | osid.type.Type | dispatchRecordType | a dispatch record type |
Return | osid.subscription.DispatchList | the returned Dispatch list | |
Errors | NULL_ARGUMENT | dispatchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getDispatchesByProvider | ||
Description |
Gets a In active mode, dispatches are returned that are currently active. In any status mode, active and inactive dispatches are returned. | ||
Parameters | osid.id.Id | resourceId | a resource Id |
Return | osid.subscription.DispatchList | the returned Dispatch list | |
Errors | NULL_ARGUMENT | resourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getDispatches | ||
Description |
Gets all In plenary mode, the returned list contains all known dispatches or an error results. Otherwise, the returned list may contain only those dispatches that are accessible through this session. In active mode, dispatches are returned that are currently active. In any status mode, active and inactive dispatches are returned. | ||
Return | osid.subscription.DispatchList | a list of Dispatches | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |