Interface | osid.subscription.DispatchAdminSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create a For updates, The delete operations delete This session includes an | ||
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 | canCreateDispatches | ||
Description |
Tests if this user can create | ||
Return | boolean | false if Dispatch creation is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateDispatchWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | dispatchRecordTypes | array of dispatch record types |
Return | boolean | true if Dispatch creation using the specified
record Types is supported, false otherwise | |
Errors | NULL_ARGUMENT | dispatchRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getDispatchFormForCreate | ||
Description |
Gets the dispatch form for creating new dispatches. A new form should be requested for each create transaction. | ||
Parameters | osid.type.Type[] | dispatchRecordTypes | array of dispatch record types |
Return | osid.subscription.DispatchForm | the dispatch form | |
Errors | NULL_ARGUMENT | dispatchRecordTypes is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to get from for requested record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createDispatch | ||
Description |
Creates a new | ||
Parameters | osid.subscription.DispatchForm | dispatchForm | the form for this Dispatch |
Return | osid.subscription.Dispatch | the new Dispatch | |
Errors | ILLEGAL_STATE | dispatchForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | dispatchForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | dispatchForm did not originate from
getDispatchFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateDispatches | ||
Description |
Tests if this user can update | ||
Return | boolean | false if Dispatch modification is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getDispatchFormForUpdate | ||
Description |
Gets the dispatch form for updating an existing dispatch. A new dispatch form should be requested for each update transaction. | ||
Parameters | osid.id.Id | dispatchId | the Id of the Dispatch |
Return | osid.subscription.DispatchForm | the dispatch form | |
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 | updateDispatch | ||
Description |
Updates an existing dispatch. | ||
Parameters | osid.subscription.DispatchForm | dispatchForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | dispatchForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | dispatchId or dispatchForm is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | dispatchForm did not originate from
getDispatchFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteDispatches | ||
Description |
Tests if this user can delete | ||
Return | boolean | false if Dispatch deletion is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteDispatch | ||
Description |
Deletes a | ||
Parameters | osid.id.Id | dispatchId | the Id of the Dispatch to remove |
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 must be implemented. | |
Method | canManageDispatchAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if Dispatch aliasing is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasDispatch | ||
Description |
Adds an | ||
Parameters | osid.id.Id | dispatchId | the Id of a Dispatch |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | dispatchId not found | ||
NULL_ARGUMENT | dispatchId or aliasId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |