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.
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.
|
aliasSubscription, canCreateSubscriptions, canCreateSubscriptionWithRecordTypes, canDeleteSubscriptions, canManageSubscriptionAliases, canUpdateSubscriptions, createSubscription, deleteSubscription, getPublisher, getPublisherId, getSubscriptionFormForCreate, getSubscriptionFormForUpdate, updateSubscription
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
SubscriptionBatchFormList getSubscriptionFormsForCreate(SubscriptionPeerList peers, Type[] subscriptionRecordTypes) throws NotFoundException, OperationFailedException, PermissionDeniedException
SubscriptionForm
is returned for each dispatch and
subscriber pair.peers
- the subscription peerssubscriptionRecordTypes
- array of subscription record types to
be included in each create operation or an empty list if noneNotFoundException
- a dispatchId
or
subscriberId
is not foundNullArgumentException
- peers
or
subscriptionRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to request forms with
given record typesmandatory
- This method must be implemented. CreateResponseList createSubscriptions(SubscriptionBatchFormList subscriptionForms) throws OperationFailedException, PermissionDeniedException
Subscriptions.
This method returns
an error if the entire operation fails. Otherwise, the status of an
individual create operation is indicated in the
BatchCreateResponse
.subscriptionForms
- the subscription formsNullArgumentException
- subscriptionForms
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SubscriptionBatchFormList getSubscriptionFormsForUpdate(IdList subscriptionIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
subscriptionIds
- the Ids
of the
Subscription
NotFoundException
- a subscriptionId
is
not foundNullArgumentException
- subscriptionIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. UpdateResponseList updateSubscriptions(SubscriptionBatchFormList subscriptionForms) throws OperationFailedException, PermissionDeniedException
BatchCreateResponse
.subscriptionForms
- the form containing the elements to be
updatedNullArgumentException
- subscriptionForms
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAllSubscriptions() throws OperationFailedException, PermissionDeniedException
Subscriptions
in this Publisher
.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteSubscriptions(IdList subscriptionIds) throws OperationFailedException, PermissionDeniedException
Ids.
subscriptionIds
- the Ids
of the subscriptions to
deleteNullArgumentException
- subscriptionIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteSubscriptionsForDispatch(Id dispatchId) throws OperationFailedException, PermissionDeniedException
dispatchId
- an Id
of a dispatchNullArgumentException
- dispatchId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteSubscriptionsForSubscriber(Id resourceId) throws OperationFailedException, PermissionDeniedException
resourceId
- an Id
of a resourceNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteIneffectiveSubscriptionsByDate(DateTime date) throws OperationFailedException, PermissionDeniedException
date
- a dateNullArgumentException
- date
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AliasResponseList aliasSubscriptions(AliasRequestList aliasRequests) throws OperationFailedException, PermissionDeniedException
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.
aliasRequests
- the alias requestsNullArgumentException
- aliasRequests
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.