Interface | osid.blogging.BlogAdminSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create a For updates, The delete operations delete | ||
Method | canCreateBlogs | ||
Description |
Tests if this user can create | ||
Return | boolean | false if Blog creation is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateBlogWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | blogRecordTypes | array of blog record types |
Return | boolean | true if Blog creation using the specified
Types is supported, false otherwise | |
Errors | NULL_ARGUMENT | blogRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getBlogFormForCreate | ||
Description |
Gets the blog form for creating new blogs. | ||
Parameters | osid.type.Type[] | blogRecordTypes | array of blog record types |
Return | osid.blogging.BlogForm | the blog form | |
Errors | NULL_ARGUMENT | blogRecordTypes is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to get form for requested record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createBlog | ||
Description |
Creates a new | ||
Parameters | osid.blogging.BlogForm | blogForm | the forms for this Blog |
Return | osid.blogging.Blog | the new Blog | |
Errors | ILLEGAL_STATE | blogForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | blogForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | blogForm did not originate from
getBlogFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateBlogs | ||
Description |
Tests if this user can update | ||
Return | boolean | false if Blog modification is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getBlogFormForUpdate | ||
Description |
Gets the blog form for updating an existing blog. A new blog form should be requested for each update transaction. | ||
Parameters | osid.id.Id | blogId | the Id of the Blog |
Return | osid.blogging.BlogForm | the blog form | |
Errors | NOT_FOUND | blogId is not found | |
NULL_ARGUMENT | blogId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateBlog | ||
Description |
Updates an existing blog. | ||
Parameters | osid.blogging.BlogForm | blogForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | blogForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | blogId or blogForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | blogForm did not originate from
getBlogFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteBlogs | ||
Description |
Tests if this user can delete | ||
Return | boolean | false if Blog deletion is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteBlog | ||
Description |
Deletes a | ||
Parameters | osid.id.Id | blogId | the Id of the Blog to remove |
Errors | NOT_FOUND | blogId not found | |
NULL_ARGUMENT | blogId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageBlogAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if Blog aliasing is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasBlog | ||
Description |
Adds an | ||
Parameters | osid.id.Id | blogId | the Id of a Blog |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is in use as a primary Id | |
NOT_FOUND | blogId not found | ||
NULL_ARGUMENT | blogId or aliasId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |