public interface ReplyBatchAdminSession extends ReplyAdminSession
This session creates, updates, and deletes Replies
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
Reply,
a ReplyForm
is requested using
getReplyFormsForCreate()
specifying the desired post and record
Types
or none if no record Types
are needed.
Each of the returned ReplyForms
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 ReplyForm
is
submiited to a create operation, it cannot be reused with another create
operation unless the first operation was unsuccessful. Each
ReplyForm
corresponds to an attempted transaction.
The ReplyForms
returned from
getReplyFormsForCreate()
may be linked to the originating request
through the peer Ids
of the ReplyForm.
In
the case where there may be duplicates, any ReplyForm
of
the same peer Ids
may be used for a create operation.
Once a batch of ReplyForms
are submitted for create, a
CreateResponse
is returned for each ReplyForm,
although the ordering is not defined. Only errors that pertain to
the entire create operation are returned from createReplies(),
errors specific to an individual ReplyForm
are
indicated in the corresponding CreateResponse.
CreateResponses
may be linked to the originating ReplyForm
through the ReplyForm
Id
.
For updates, ReplyForms
are requested to the
Reply
Id
that is to be updated using
getReplyFormsForUpdate()
where the reference Id
in
the ReplyForm
may be used to link the request. Similarly,
the ReplyForm
has metadata about the data that can be
updated and it can perform validation before submitting the update. The
ReplyForm
can only be used once for a successful update and
cannot be reused.
Once a batch of ReplyForms
are submitted for update, an
UpdateResponse
is returned for each ReplyForm,
although the ordering is not defined. Only errors that pertain to
the entire update operation are returned from updateReplies(),
errors specific to an individual ReplyForm
are
indicated in the corresponding UpdateResponse.
UpdateResponses
may be linked to the originating ReplyForm
through the ReplyForm
Id.
The delete operations delete Replies
in bulk. To unmap
a Reply
from the current Forum,
the
ReplyForumAssignmentSession
should be used. These delete
operations attempt to remove the Reply
itself thus removing
it from all known Forum
catalogs. Bulk delete operations
return the results in DeleteResponses.
Modifier and Type | Method and Description |
---|---|
AliasResponseList |
aliasReplies(AliasRequestList aliasRequests)
Adds an
Id to a Reply for the purpose of
creating compatibility. |
CreateResponseList |
createReplies(ReplyBatchFormList replyForms)
Creates a new set of
Replies. |
DeleteResponseList |
deleteAllReplies()
Deletes all
Replies in this Forum . |
DeleteResponseList |
deleteChildReplies(Id replyId)
Deletes replies under the given reply.
|
DeleteResponseList |
deleteReplies(IdList replyIds)
Deletes replies for the given
Ids. |
DeleteResponseList |
deleteRepliesByPoster(Id resourceId)
Deletes replies for the given poster.
|
DeleteResponseList |
deleteRepliesForPost(Id postId)
Deletes replies for the given post.
|
ReplyBatchFormList |
getReplyFormsForCreate(IdList postIds,
Type[] replyRecordTypes)
Gets the reply forms for creating a bunch of new replies.
|
ReplyBatchFormList |
getReplyFormsForUpdate(IdList replyIds)
Gets the reply forms for updating an existing set of replies.
|
UpdateResponseList |
updateReplies(ReplyBatchFormList replyForms)
Updates existing replies.
|
aliasReply, canCreateReplies, canCreateReplyWithRecordTypes, canDeleteReplies, canManageReplyAliases, canUpdateReplies, createReply, deleteReply, getForum, getForumId, getReplyFormForCreateToPost, getReplyFormForCreateToReply, getReplyFormForUpdate, updateReply
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
ReplyBatchFormList getReplyFormsForCreate(IdList postIds, Type[] replyRecordTypes) throws NotFoundException, OperationFailedException, PermissionDeniedException
postIds
- the post or reply Ids
replyRecordTypes
- array of reply record types to be included in
each create operation or an empty list if noneNotFoundException
- a postId
is not
foundNullArgumentException
- postIds
or
replyRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to request forms with
given record typesmandatory
- This method must be implemented. CreateResponseList createReplies(ReplyBatchFormList replyForms) throws OperationFailedException, PermissionDeniedException
Replies.
This method returns an
error if the entire operation fails. Otherwise, the status of an
individual create operation is indicated in the
BatchCreateResponse
.replyForms
- the reply formsNullArgumentException
- replyForms
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ReplyBatchFormList getReplyFormsForUpdate(IdList replyIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
replyIds
- the Ids
of the Reply
NotFoundException
- a replyId
is not
foundNullArgumentException
- replyIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. UpdateResponseList updateReplies(ReplyBatchFormList replyForms) throws OperationFailedException, PermissionDeniedException
BatchCreateResponse
.replyForms
- the form containing the elements to be updatedNullArgumentException
- replyForms
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAllReplies() throws OperationFailedException, PermissionDeniedException
Replies
in this Forum
.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteReplies(IdList replyIds) throws OperationFailedException, PermissionDeniedException
Ids.
replyIds
- the Ids
of the replies to deleteNullArgumentException
- replyIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteRepliesForPost(Id postId) throws OperationFailedException, PermissionDeniedException
postId
- an Id
of a postNullArgumentException
- postId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteRepliesByPoster(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 deleteChildReplies(Id replyId) throws OperationFailedException, PermissionDeniedException
replyId
- an Id
of a replyNullArgumentException
- replyId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AliasResponseList aliasReplies(AliasRequestList aliasRequests) throws OperationFailedException, PermissionDeniedException
Id
to a Reply
for the purpose of
creating compatibility. The primary Id
of the
Reply
is determined by the provider. The new Id
is an alias to the primary Id.
If the alias is a
pointer to another reply, it is reassigned to the given reply
Id.
aliasRequests
- the alias requestsNullArgumentException
- aliasRequests
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.