org.osid.subscription.batch

Interface SubscriptionBatchAdminSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession, SubscriptionAdminSession

public interface SubscriptionBatchAdminSession
extends SubscriptionAdminSession

This session creates, updates, and deletes Subscriptions in bulk. The data for create and update is provided by the consumer via the form object. OsidForms are requested for each create or update and may not be reused.

Create and update operations differ in their usage. To create a Subscription, a SubscriptionForm is requested using getSubscriptionFormsForCreate() specifying the desired dispatch, subscriber, and record Types or none if no record Types are needed. Each of the returned SubscriptionForms will indicate that it is to be used with a create operation and can be used to examine metdata or validate data prior to creation. Once a SubscriptionForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each SubscriptionForm corresponds to an attempted transaction.

The SubscriptionForms returned from getSubscriptionFormsForCreate() may be linked to the originating request through the peer Ids of the SubscriptionForm. In the case where there may be duplicates, any SubscriptionForm of the same peer Ids may be used for a create operation.

Once a batch of SubscriptionForms are submitted for create, a CreateResponse is returned for each SubscriptionForm, although the ordering is not defined. Only errors that pertain to the entire create operation are returned from createSubscriptions(), errors specific to an individual SubscriptionForm are indicated in the corresponding CreateResponse. CreateResponses may be linked to the originating SubscriptionForm through the SubscriptionForm Id .

For updates, SubscriptionForms are requested to the Subscription Id that is to be updated using getSubscriptionFormsForUpdate() where the reference Id in the SubscriptionForm may be used to link the request. Similarly, the SubscriptionForm has metadata about the data that can be updated and it can perform validation before submitting the update. The SubscriptionForm can only be used once for a successful update and cannot be reused.

Once a batch of SubscriptionForms are submitted for update, an UpdateResponse is returned for each SubscriptionForm, although the ordering is not defined. Only errors that pertain to the entire update operation are returned from updateSubscriptions(), errors specific to an individual SubscriptionForm are indicated in the corresponding UpdateResponse. UpdateResponses may be linked to the originating SubscriptionForm through the SubscriptionForm Id.

The delete operations delete Subscriptions in bulk. To unmap a Subscription from the current Publisher, the SubscriptionPublisherAssignmentSession should be used. These delete operations attempt to remove the Subscription itself thus removing it from all known Publisher catalogs. Bulk delete operations return the results in DeleteResponses.

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasSubscriptions(AliasRequestList aliasRequests) Adds an Id to a Subscription for the purpose of creating compatibility.
CreateResponseList	createSubscriptions(SubscriptionBatchFormList subscriptionForms) Creates a new set of Subscriptions.
DeleteResponseList	deleteAllSubscriptions() Deletes all Subscriptions in this Publisher .
DeleteResponseList	deleteIneffectiveSubscriptionsByDate(DateTime date) Deletes all subscriptions expired before the given date.
DeleteResponseList	deleteSubscriptions(IdList subscriptionIds) Deletes subscriptions for the given Ids.
DeleteResponseList	deleteSubscriptionsForDispatch(Id dispatchId) Deletes all subscriptions for the given dispatch.
DeleteResponseList	deleteSubscriptionsForSubscriber(Id resourceId) Deletes all subscriptions for the given subscriber.
SubscriptionBatchFormList	getSubscriptionFormsForCreate(SubscriptionPeerList peers, Type[] subscriptionRecordTypes) Gets the subscription forms for creating a bunch of new subscriptions.
SubscriptionBatchFormList	getSubscriptionFormsForUpdate(IdList subscriptionIds) Gets the subscription forms for updating an existing set of subscriptions.
UpdateResponseList	updateSubscriptions(SubscriptionBatchFormList subscriptionForms) Updates existing subscriptions.

Methods inherited from interface org.osid.subscription.SubscriptionAdminSession

aliasSubscription, canCreateSubscriptions, canCreateSubscriptionWithRecordTypes, canDeleteSubscriptions, canManageSubscriptionAliases, canUpdateSubscriptions, createSubscription, deleteSubscription, getPublisher, getPublisherId, getSubscriptionFormForCreate, getSubscriptionFormForUpdate, updateSubscription

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getSubscriptionFormsForCreate

SubscriptionBatchFormList getSubscriptionFormsForCreate(SubscriptionPeerList peers,
                                                      Type[] subscriptionRecordTypes)
                                                        throws NotFoundException,
                                                               OperationFailedException,
                                                               PermissionDeniedException

Gets the subscription forms for creating a bunch of new subscriptions. A SubscriptionForm is returned for each dispatch and subscriber pair.

Parameters:

peers - the subscription peers

subscriptionRecordTypes - array of subscription record types to be included in each create operation or an empty list if none

Returns:

the subscription forms

Throws:

NotFoundException - a dispatchId or subscriberId is not found

NullArgumentException - peers or subscriptionRecordTypes is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - unable to request forms with given record types

Compliance:

mandatory - This method must be implemented.

createSubscriptions

CreateResponseList createSubscriptions(SubscriptionBatchFormList subscriptionForms)
                                       throws OperationFailedException,
                                              PermissionDeniedException

Creates a new set of Subscriptions. This method returns an error if the entire operation fails. Otherwise, the status of an individual create operation is indicated in the BatchCreateResponse .

Parameters:

subscriptionForms - the subscription forms

Returns:

the create responses

Throws:

NullArgumentException - subscriptionForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSubscriptionFormsForUpdate

SubscriptionBatchFormList getSubscriptionFormsForUpdate(IdList subscriptionIds)
                                                        throws NotFoundException,
                                                               OperationFailedException,
                                                               PermissionDeniedException

Gets the subscription forms for updating an existing set of subscriptions. A new subscription form should be requested for each update transaction.

Parameters:

subscriptionIds - the Ids of the Subscription

Returns:

the subscription form

Throws:

NotFoundException - a subscriptionId is not found

NullArgumentException - subscriptionIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateSubscriptions

UpdateResponseList updateSubscriptions(SubscriptionBatchFormList subscriptionForms)
                                       throws OperationFailedException,
                                              PermissionDeniedException

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 BatchCreateResponse .

Parameters:

subscriptionForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - subscriptionForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllSubscriptions

DeleteResponseList deleteAllSubscriptions()
                                          throws OperationFailedException,
                                                 PermissionDeniedException

Deletes all Subscriptions in this Publisher .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteSubscriptions

DeleteResponseList deleteSubscriptions(IdList subscriptionIds)
                                       throws OperationFailedException,
                                              PermissionDeniedException

Deletes subscriptions for the given Ids.

Parameters:

subscriptionIds - the Ids of the subscriptions to delete

Returns:

the delete responses

Throws:

NullArgumentException - subscriptionIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteSubscriptionsForDispatch

DeleteResponseList deleteSubscriptionsForDispatch(Id dispatchId)
                                                  throws OperationFailedException,
                                                         PermissionDeniedException

Deletes all subscriptions for the given dispatch.

Parameters:

dispatchId - an Id of a dispatch

Returns:

the delete responses

Throws:

NullArgumentException - dispatchId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteSubscriptionsForSubscriber

DeleteResponseList deleteSubscriptionsForSubscriber(Id resourceId)
                                                    throws OperationFailedException,
                                                           PermissionDeniedException

Deletes all subscriptions for the given subscriber.

Parameters:

resourceId - an Id of a resource

Returns:

the delete responses

Throws:

NullArgumentException - resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteIneffectiveSubscriptionsByDate

DeleteResponseList deleteIneffectiveSubscriptionsByDate(DateTime date)
                                                        throws OperationFailedException,
                                                               PermissionDeniedException

Deletes all subscriptions expired before the given date.

Parameters:

date - a date

Returns:

the delete responses

Throws:

NullArgumentException - date is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasSubscriptions

AliasResponseList aliasSubscriptions(AliasRequestList aliasRequests)
                                     throws OperationFailedException,
                                            PermissionDeniedException

Adds an Id to a Subscription for the purpose of creating compatibility. The primary Id of the Subscription is determined by the provider. The new Id is an alias to the primary Id. If the alias is a pointer to another subscription, it is reassigned to the given subscription Id.

Parameters:

aliasRequests - the alias requests

Returns:

the alias responses

Throws:

NullArgumentException - aliasRequests is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.