OSID Logo
OSID Specifications
blogging package
Version 3.0.0
Release Candidate Preview
Interfaceosid.blogging.EntryBlogAssignmentSession
Implementsosid.OsidSession
Description

This session provides methods to re-assign Entries to Blogs. An Entry may map to multiple Blog objects and removing the last reference to an Entry is the equivalent of deleting it. Each Blog may have its own authorizations governing who is allowed to operate on it.

Moving or adding a reference of a Entry to another Blog is not a copy operation (eg: does not change its Id ).

MethodcanAssignEntries
Description

Tests if this user can alter entry/blog mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer assignment operations to unauthorized users.

Returnboolean false if mapping is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanAssignEntriesToBlog
Description

Tests if this user can alter entry/blog mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer assignment operations to unauthorized users.

Parametersosid.id.IdblogIdthe Id of the Blog
Returnboolean false if mapping is not authorized, true otherwise
ErrorsNULL_ARGUMENT blogId is null
CompliancemandatoryThis method must be implemented.
MethodgetAssignableBlogIds
Description

Gets a list of blogs including and under the given blogs node in which any entry can be assigned.

Parametersosid.id.IdblogIdthe Id of the Blog
Returnosid.id.IdListlist of assignable blog Ids
ErrorsNULL_ARGUMENT blogId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetAssignableBlogIdsForEntry
Description

Gets a list of blogs including and under the given blog node in which a specific entry can be assigned.

Parametersosid.id.IdblogIdthe Id of the Blog
osid.id.IdentryIdthe Id of the Entry
Returnosid.id.IdListlist of assignable blog Ids
ErrorsNULL_ARGUMENT blogId or entryId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignEntryToBlog
Description

Adds an existing Entry to a Blog.

Parametersosid.id.IdentryIdthe Id of the Entry
osid.id.IdblogIdthe Id of the Blog
ErrorsALREADY_EXISTS entryId is already assigned to blogId
NOT_FOUND entryId or blogId not found
NULL_ARGUMENT entryId or blogId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignEntryFromBlog
Description

Removes an Entry from a Blog.

Parametersosid.id.IdentryIdthe Id of the Entry
osid.id.IdblogIdthe Id of the Blog
ErrorsNOT_FOUND entryId or blogId not found or entryId not assigned to blogId
NULL_ARGUMENT entryId or blogId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodreassignEntryToBlog
Description

Moves an Entry from one Blog to another. Mappings to other Blogs are unaffected.

Parametersosid.id.IdentryIdthe Id of the Entry
osid.id.IdfromBlogIdthe Id of the current Blog
osid.id.IdtoBlogIdthe Id of the destination Blog
ErrorsNOT_FOUND entryId, fromBlogId, or toBlogId not found or entryId not mapped to fromBlogId
NULL_ARGUMENT entryId, fromBlogId, or toBlogId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.