org.osid.subscription.batch

Interface PublisherBatchAdminSession

All Superinterfaces:

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

public interface PublisherBatchAdminSession
extends PublisherAdminSession

This session creates, updates, and deletes Publishers 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 Publisher, a PublisherForm is requested using getPublisherFormsForCreate() specifying the desired record Types or none if no record Types are needed. Each of the returned PublisherForms 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 PublisherForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each PublisherForm corresponds to an attempted transaction.

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

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

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

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

The delete operations delete Publishers in bulk. Bulk delete operations return the results in DeleteResponses.

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasPublishers(AliasRequestList aliasRequests) Adds an Id to a Publisher for the purpose of creating compatibility.
CreateResponseList	createPublishers(PublisherBatchFormList publisherForms) Creates a new set of Publishers.
DeleteResponseList	deleteAllPublishers() Deletes all Publishers.
DeleteResponseList	deletePublishers(IdList publisherIds) Deletes publishers for the given Ids.
PublisherBatchFormList	getPublisherFormsForCreate(long number, Type[] publisherRecordTypes) Gets the publisher forms for creating a bunch of new publishers.
PublisherBatchFormList	getPublisherFormsForUpdate(IdList publisherIds) Gets the publisher forms for updating an existing set of publishers.
UpdateResponseList	updatePublishers(PublisherBatchFormList publisherForms) Updates existing publishers.

Methods inherited from interface org.osid.subscription.PublisherAdminSession

aliasPublisher, canCreatePublishers, canCreatePublisherWithRecordTypes, canDeletePublishers, canManagePublisherAliases, canUpdatePublishers, createPublisher, deletePublisher, getPublisherFormForCreate, getPublisherFormForUpdate, updatePublisher

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

getPublisherFormsForCreate

PublisherBatchFormList getPublisherFormsForCreate(long number,
                                                Type[] publisherRecordTypes)
                                                  throws OperationFailedException,
                                                         PermissionDeniedException

Gets the publisher forms for creating a bunch of new publishers.

Parameters:

number - the number of forms to retrieve

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

Returns:

the publisher forms

Throws:

NullArgumentException - publisherRecordTypes 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.

createPublishers

CreateResponseList createPublishers(PublisherBatchFormList publisherForms)
                                    throws OperationFailedException,
                                           PermissionDeniedException

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

Parameters:

publisherForms - the publisher forms

Returns:

the create responses

Throws:

NullArgumentException - publisherForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPublisherFormsForUpdate

PublisherBatchFormList getPublisherFormsForUpdate(IdList publisherIds)
                                                  throws NotFoundException,
                                                         OperationFailedException,
                                                         PermissionDeniedException

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

Parameters:

publisherIds - the Ids of the Publisher

Returns:

the publisher form

Throws:

NotFoundException - a publisherId is not found

NullArgumentException - publisherIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updatePublishers

UpdateResponseList updatePublishers(PublisherBatchFormList publisherForms)
                                    throws OperationFailedException,
                                           PermissionDeniedException

Updates existing publishers. This method returns an error if the entire operation fails. Otherwise, the status of an individual update operation is indicated in the BatchCreateResponse .

Parameters:

publisherForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - publisherForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllPublishers

DeleteResponseList deleteAllPublishers()
                                       throws OperationFailedException,
                                              PermissionDeniedException

Deletes all Publishers.

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deletePublishers

DeleteResponseList deletePublishers(IdList publisherIds)
                                    throws OperationFailedException,
                                           PermissionDeniedException

Deletes publishers for the given Ids.

Parameters:

publisherIds - the Ids of the publishers to delete

Returns:

the delete responses

Throws:

NullArgumentException - publisherIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasPublishers

AliasResponseList aliasPublishers(AliasRequestList aliasRequests)
                                  throws OperationFailedException,
                                         PermissionDeniedException

Adds an Id to a Publisher for the purpose of creating compatibility. The primary Id of the Publisher is determined by the provider. The new Id is an alias to the primary Id. If the alias is a pointer to another publisher, it is reassigned to the given publisher 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.