public interface BlogBatchAdminSession extends BlogAdminSession
This session creates, updates, and deletes Blogs
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 an
Blog,
an BlogForm
is requested using
getBlogFormsForCreate()
specifying the desired record Types
or none if no record Types
are needed. Each of the
returned BlogForms
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 an BlogForm
is submiited to a
create operation, it cannot be reused with another create operation unless
the first operation was unsuccessful. Each BlogForm
corresponds to an attempted transaction.
The BlogForms
returned from
getBlogFormsForCreate()
may be linked to the originating request
through the peer Ids
of the BlogForm.
In the
case where there may be duplicates, any BlogForm
of the
same peer Ids
may be used for a create operation.
Once a batch of BlogForms
are submitted for create, a
CreateResponse
is returned for each BlogForm,
although the ordering is not defined. Only errors that pertain to
the entire create operation are returned from createBlogs(),
errors specific to an individual BlogForm
are
indicated in the corresponding CreateResponse.
CreateResponses
may be linked to the originating BlogForm
through the BlogForm
Id
.
For updates, BlogForms
are requested to the Blog
Id
that is to be updated using
getBlogFormsForUpdate()
where the reference Id
in
the BlogForm
may be used to link the request. Similarly,
the BlogForm
has metadata about the data that can be
updated and it can perform validation before submitting the update. The
BlogForm
can only be used once for a successful update and
cannot be reused.
Once a batch of BlogForms
are submitted for update, an
UpdateResponse
is returned for each BlogForm,
although the ordering is not defined. Only errors that pertain to
the entire update operation are returned from updateBlogs(),
errors specific to an individual BlogForm
are
indicated in the corresponding UpdateResponse.
UpdateResponses
may be linked to the originating BlogForm
through the BlogForm
Id.
The delete operations delete Blogs
in bulk. Bulk delete
operations return the results in DeleteResponses.
Modifier and Type | Method and Description |
---|---|
AliasResponseList |
aliasBlogs(AliasRequestList aliasRequests)
Adds an
Id to an Blog for the purpose of
creating compatibility. |
CreateResponseList |
createBlogs(BlogBatchFormList blogForms)
Creates a new set of
Blogs. |
DeleteResponseList |
deleteAllBlogs()
Deletes all
Blogs. |
DeleteResponseList |
deleteBlogs(IdList blogIds)
Deletes blogs for the given
Ids. |
BlogBatchFormList |
getBlogFormsForCreate(long number,
Type[] blogRecordTypes)
Gets the blog forms for creating a bunch of new blogs.
|
BlogBatchFormList |
getBlogFormsForUpdate(IdList blogIds)
Gets the blog forms for updating an existing set of blogs.
|
UpdateResponseList |
updateBlogs(BlogBatchFormList blogForms)
Updates existing blogs.
|
aliasBlog, canCreateBlogs, canCreateBlogWithRecordTypes, canDeleteBlogs, canManageBlogAliases, canUpdateBlogs, createBlog, deleteBlog, getBlogFormForCreate, getBlogFormForUpdate, updateBlog
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
BlogBatchFormList getBlogFormsForCreate(long number, Type[] blogRecordTypes) throws OperationFailedException, PermissionDeniedException
number
- the number of forms to retrieveblogRecordTypes
- array of blog record types to be included in
each create operation or an empty list if noneNullArgumentException
- blogRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to request forms with
given record typesmandatory
- This method must be implemented. CreateResponseList createBlogs(BlogBatchFormList blogForms) throws OperationFailedException, PermissionDeniedException
Blogs.
This method returns an
error if the entire operation fails. Otherwise, the status of an
individual create operation is indicated in the
BatchCreateResponse
.blogForms
- the blog formsNullArgumentException
- blogForms
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. BlogBatchFormList getBlogFormsForUpdate(IdList blogIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
blogIds
- the Ids
of the Blog
NotFoundException
- an blogId
is not
foundNullArgumentException
- blogIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. UpdateResponseList updateBlogs(BlogBatchFormList blogForms) throws OperationFailedException, PermissionDeniedException
BatchCreateResponse
.blogForms
- the form containing the elements to be updatedNullArgumentException
- blogForms
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAllBlogs() throws OperationFailedException, PermissionDeniedException
Blogs.
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteBlogs(IdList blogIds) throws OperationFailedException, PermissionDeniedException
Ids.
blogIds
- the Ids
of the blogs to deleteNullArgumentException
- blogIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AliasResponseList aliasBlogs(AliasRequestList aliasRequests) throws OperationFailedException, PermissionDeniedException
Id
to an Blog
for the purpose of
creating compatibility. The primary Id
of the
Blog
is determined by the provider. The new Id
is an alias to the primary Id.
If the alias is a
pointer to another blog, it is reassigned to the given entry
Id.
aliasRequests
- the alias requestsNullArgumentException
- aliasRequests
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.