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.
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.
|
aliasPublisher, canCreatePublishers, canCreatePublisherWithRecordTypes, canDeletePublishers, canManagePublisherAliases, canUpdatePublishers, createPublisher, deletePublisher, getPublisherFormForCreate, getPublisherFormForUpdate, updatePublisher
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
PublisherBatchFormList getPublisherFormsForCreate(long number, Type[] publisherRecordTypes) throws OperationFailedException, PermissionDeniedException
number
- the number of forms to retrievepublisherRecordTypes
- array of publisher record types to be
included in each create operation or an empty list if noneNullArgumentException
- publisherRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to request forms with
given record typesmandatory
- This method must be implemented. CreateResponseList createPublishers(PublisherBatchFormList publisherForms) throws OperationFailedException, PermissionDeniedException
Publishers.
This method returns an
error if the entire operation fails. Otherwise, the status of an
individual create operation is indicated in the
BatchCreateResponse
.publisherForms
- the publisher formsNullArgumentException
- publisherForms
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PublisherBatchFormList getPublisherFormsForUpdate(IdList publisherIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
publisherIds
- the Ids
of the Publisher
NotFoundException
- a publisherId
is not
foundNullArgumentException
- publisherIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. UpdateResponseList updatePublishers(PublisherBatchFormList publisherForms) throws OperationFailedException, PermissionDeniedException
BatchCreateResponse
.publisherForms
- the form containing the elements to be updatedNullArgumentException
- publisherForms
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAllPublishers() throws OperationFailedException, PermissionDeniedException
Publishers.
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deletePublishers(IdList publisherIds) throws OperationFailedException, PermissionDeniedException
Ids.
publisherIds
- the Ids
of the publishers to
deleteNullArgumentException
- publisherIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AliasResponseList aliasPublishers(AliasRequestList aliasRequests) throws OperationFailedException, PermissionDeniedException
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.
aliasRequests
- the alias requestsNullArgumentException
- aliasRequests
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.