public interface PostBatchAdminSession extends PostAdminSession
This session creates, updates, and deletes Posts
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
Post,
a PostForm
is requested using
getPostFormsForCreate()
specifying the desired record Types
or none if no record Types
are needed. Each of the
returned PostForms
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 PostForm
is submiited to a create
operation, it cannot be reused with another create operation unless the
first operation was unsuccessful. Each PostForm
corresponds
to an attempted transaction.
The PostForms
returned from
getPostFormsForCreate()
may be linked to the originating request
through the peer Ids
of the PostForm.
In the
case where there may be duplicates, any PostForm
of the
same peer Ids
may be used for a create operation.
Once a batch of PostForms
are submitted for create, a
CreateResponse
is returned for each PostForm,
although the ordering is not defined. Only errors that pertain to
the entire create operation are returned from createPosts(),
errors specific to an individual PostForm
are
indicated in the corresponding CreateResponse.
CreateResponses
may be linked to the originating PostForm
through the PostForm
Id
.
For updates, PostForms
are requested to the Post
Id
that is to be updated using
getPostFormsForUpdate()
where the reference Id
in
the PostForm
may be used to link the request. Similarly,
the PostForm
has metadata about the data that can be
updated and it can perform validation before submitting the update. The
PostForm
can only be used once for a successful update and
cannot be reused.
Once a batch of PostForms
are submitted for update, an
UpdateResponse
is returned for each PostForm,
although the ordering is not defined. Only errors that pertain to
the entire update operation are returned from updatePosts(),
errors specific to an individual PostForm
are
indicated in the corresponding UpdateResponse.
UpdateResponses
may be linked to the originating PostForm
through the PostForm
Id.
The delete operations delete Posts
in bulk. To unmap a
Post
from the current Forum,
the
PostForumAssignmentSession
should be used. These delete operations
attempt to remove the Post
itself thus removing it from all
known Forum
catalogs. Bulk delete operations return the
results in DeleteResponses.
Modifier and Type | Method and Description |
---|---|
AliasResponseList |
aliasPosts(AliasRequestList aliasRequests)
Adds an
Id to a Post for the purpose of
creating compatibility. |
CreateResponseList |
createPosts(PostBatchFormList postForms)
Creates a new set of
Posts. |
DeleteResponseList |
deleteAllPosts()
Deletes all
Posts in this Forum . |
DeleteResponseList |
deletePosts(IdList postIds)
Deletes posts for the given
Ids. |
DeleteResponseList |
deletePostsByPoster(Id resourceId)
Deletes posts for the given resource.
|
PostBatchFormList |
getPostFormsForCreate(long number,
Type[] postRecordTypes)
Gets the post forms for creating a bunch of new posts.
|
PostBatchFormList |
getPostFormsForUpdate(IdList postIds)
Gets the post forms for updating an existing set of posts.
|
UpdateResponseList |
updatePosts(PostBatchFormList postForms)
Updates existing posts.
|
aliasPost, canCreatePosts, canCreatePostWithRecordTypes, canDeletePosts, canManagePostAliases, canUpdatePosts, createPost, deletePost, getForum, getForumId, getPostFormForCreate, getPostFormForUpdate, updatePost
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
PostBatchFormList getPostFormsForCreate(long number, Type[] postRecordTypes) throws OperationFailedException, PermissionDeniedException
number
- the number of forms to retrievepostRecordTypes
- array of post record types to be included in
each create operation or an empty list if noneNullArgumentException
- postRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to request forms with
given record typesmandatory
- This method must be implemented. CreateResponseList createPosts(PostBatchFormList postForms) throws OperationFailedException, PermissionDeniedException
Posts.
This method returns an
error if the entire operation fails. Otherwise, the status of an
individual create operation is indicated in the
BatchCreateResponse
.postForms
- the post formsNullArgumentException
- postForms
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PostBatchFormList getPostFormsForUpdate(IdList postIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
postIds
- the Ids
of the Post
NotFoundException
- a postId
is not
foundNullArgumentException
- postIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. UpdateResponseList updatePosts(PostBatchFormList postForms) throws OperationFailedException, PermissionDeniedException
BatchCreateResponse
.postForms
- the form containing the elements to be updatedNullArgumentException
- postForms
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAllPosts() throws OperationFailedException, PermissionDeniedException
Posts
in this Forum
.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deletePosts(IdList postIds) throws OperationFailedException, PermissionDeniedException
Ids.
postIds
- the Ids
of the posts to deleteNullArgumentException
- postIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deletePostsByPoster(Id resourceId) throws OperationFailedException, PermissionDeniedException
resourceId
- the Id
of a resourceNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AliasResponseList aliasPosts(AliasRequestList aliasRequests) throws OperationFailedException, PermissionDeniedException
Id
to a Post
for the purpose of
creating compatibility. The primary Id
of the
Post
is determined by the provider. The new Id
is an alias to the primary Id.
If the alias is a
pointer to another post, it is reassigned to the given post Id.
aliasRequests
- the alias requestsNullArgumentException
- aliasRequests
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.