Interface | osid.subscription.batch.SubscriptionBatchAdminSession | ||
---|---|---|---|
Implements | osid.subscription.SubscriptionAdminSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create a The Once a batch of For updates, Once a batch of The delete operations delete | ||
Method | getSubscriptionFormsForCreate | ||
Description |
Gets the subscription forms for creating a bunch of new
subscriptions. A | ||
Parameters | osid.subscription.batch.SubscriptionPeerList | peers | the subscription peers |
osid.type.Type[] | subscriptionRecordTypes | array of subscription record types to be included in each create operation or an empty list if none | |
Return | osid.subscription.batch.SubscriptionBatchFormList | the subscription forms | |
Errors | NOT_FOUND | a dispatchId or subscriberId is not found | |
NULL_ARGUMENT | peers or subscriptionRecordTypes is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to request forms with given record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createSubscriptions | ||
Description |
Creates a new set of | ||
Parameters | osid.subscription.batch.SubscriptionBatchFormList | subscriptionForms | the subscription forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | subscriptionForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSubscriptionFormsForUpdate | ||
Description |
Gets the subscription forms for updating an existing set of subscriptions. A new subscription form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | subscriptionIds | the Ids of the Subscription |
Return | osid.subscription.batch.SubscriptionBatchFormList | the subscription form | |
Errors | NOT_FOUND | a subscriptionId is not found | |
NULL_ARGUMENT | subscriptionIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateSubscriptions | ||
Description |
Updates existing subscriptions. This method returns an
error if the entire operation fails. Otherwise, the status
of an individual update operation is indicated in the
| ||
Parameters | osid.subscription.batch.SubscriptionBatchFormList | subscriptionForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | subscriptionForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllSubscriptions | ||
Description |
Deletes all | ||
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteSubscriptions | ||
Description |
Deletes subscriptions for the given | ||
Parameters | osid.id.IdList | subscriptionIds | the Ids of the subscriptions to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | subscriptionIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteSubscriptionsForDispatch | ||
Description |
Deletes all subscriptions for the given dispatch. | ||
Parameters | osid.id.Id | dispatchId | an Id of a dispatch |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | dispatchId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteSubscriptionsForSubscriber | ||
Description |
Deletes all subscriptions for the given subscriber. | ||
Parameters | osid.id.Id | resourceId | an Id of a resource |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | resourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteIneffectiveSubscriptionsByDate | ||
Description |
Deletes all subscriptions expired before the given date. | ||
Parameters | osid.calendaring.DateTime | date | a date |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | date is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | aliasSubscriptions | ||
Description |
Adds an | ||
Parameters | osid.transaction.batch.AliasRequestList | aliasRequests | the alias requests |
Return | osid.transaction.batch.AliasResponseList | the alias responses | |
Errors | NULL_ARGUMENT | aliasRequests is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |