OSID Logo
OSID Specifications
blogging batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.blogging.batch.BlogBatchAdminSession
Implementsosid.blogging.BlogAdminSession
Description

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.

MethodgetBlogFormsForCreate
Description

Gets the blog forms for creating a bunch of new blogs.

Parameterscardinalnumberthe number of forms to retrieve
osid.type.Type[]blogRecordTypesarray of blog record types to be included in each create operation or an empty list if none
Returnosid.blogging.batch.BlogBatchFormListthe blog forms
ErrorsNULL_ARGUMENT blogRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateBlogs
Description

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

Parametersosid.blogging.batch.BlogBatchFormListblogFormsthe blog forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT blogForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBlogFormsForUpdate
Description

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

Parametersosid.id.IdListblogIdsthe Ids of the Blog
Returnosid.blogging.batch.BlogBatchFormListthe blog form
ErrorsNOT_FOUNDan blogId is not found
NULL_ARGUMENT blogIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateBlogs
Description

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

Parametersosid.blogging.batch.BlogBatchFormListblogFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT blogForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllBlogs
Description

Deletes all Blogs.

Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteBlogs
Description

Deletes blogs for the given Ids.

Parametersosid.id.IdListblogIdsthe Ids of the blogs to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT blogIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasBlogs
Description

Adds an 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.

Parametersosid.transaction.batch.AliasRequestListaliasRequeststhe alias requests
Returnosid.transaction.batch.AliasResponseListthe alias responses
ErrorsNULL_ARGUMENT aliasRequests is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.