org.osid.blogging

Interface BloggingProfile

All Superinterfaces:

OsidProfile, Sourceable

All Known Subinterfaces:

BloggingManager, BloggingProxyManager

public interface BloggingProfile
extends OsidProfile

The entry profile describes interoperability among entry services.

Method Summary

Methods

Modifier and Type	Method and Description
TypeList	getBlogRecordTypes() Gets all the blog record types supported.
TypeList	getBlogSearchRecordTypes() Gets all the blog search record types supported.
TypeList	getEntryRecordTypes() Gets all the entry record types supported.
TypeList	getEntrySearchRecordTypes() Gets all the entry search record types supported.
boolean	supportsBlogAdmin() Tests if blog administration is supported.
boolean	supportsBlogging() Tests if sending entries is supported.
boolean	supportsBloggingBatch() Tests if a blogging batch service is supported.
boolean	supportsBlogHierarchy() Tests if a blog hierarchy traversal is supported.
boolean	supportsBlogHierarchyDesign() Tests if a blog hierarchy design is supported.
boolean	supportsBlogLookup() Tests if blog lookup is supported.
boolean	supportsBlogNotification() Tests if blog notification is supported.
boolean	supportsBlogQuery() Tests if blog query is supported.
boolean	supportsBlogRecordType(Type blogRecordType) Tests if a given blog record type is supported.
boolean	supportsBlogSearch() Tests if blog search is supported.
boolean	supportsBlogSearchRecordType(Type blogSearchRecordType) Tests if a given blog search record type is supported.
boolean	supportsEntryAdmin() Tests if creating, updating and deleting entries is supported.
boolean	supportsEntryBlog() Tests if retrieving mappings of entry and blogs is supported.
boolean	supportsEntryBlogAssignment() Tests if managing mappings of entries and blogs is supported.
boolean	supportsEntryLookup() Tests if entry lookup is supported.
boolean	supportsEntryNotification() Tests if entry notification is supported.
boolean	supportsEntryQuery() Tests if entry query is supported.
boolean	supportsEntryRecordType(Type entryRecordType) Tests if a given entry record type is supported.
boolean	supportsEntrySearch() Tests if entry search is supported.
boolean	supportsEntrySearchRecordType(Type entrySearchRecordType) Tests if a given entry search type is supported.
boolean	supportsEntrySmartBlog() Tests if entry smart blogging is available.
boolean	supportsVisibleFederation() Tests if federation is visible.

Methods inherited from interface org.osid.OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

supportsVisibleFederation

boolean supportsVisibleFederation()

Tests if federation is visible.

Returns:

true if visible federation is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsBlogging

boolean supportsBlogging()

Tests if sending entries is supported.

Returns:

true if entry sending is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsEntryLookup

boolean supportsEntryLookup()

Tests if entry lookup is supported.

Returns:

true if entry lookup is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsEntryQuery

boolean supportsEntryQuery()

Tests if entry query is supported.

Returns:

true if entry query is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsEntrySearch

boolean supportsEntrySearch()

Tests if entry search is supported.

Returns:

true if entry search is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsEntryAdmin

boolean supportsEntryAdmin()

Tests if creating, updating and deleting entries is supported.

Returns:

true if entry administration is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsEntryNotification

boolean supportsEntryNotification()

Tests if entry notification is supported. Entries may be sent when entries are created, modified, or deleted.

Returns:

true if entry notification is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsEntryBlog

boolean supportsEntryBlog()

Tests if retrieving mappings of entry and blogs is supported.

Returns:

true if entry blog mapping retrieval is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsEntryBlogAssignment

boolean supportsEntryBlogAssignment()

Tests if managing mappings of entries and blogs is supported.

Returns:

true if entry blog assignment is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsEntrySmartBlog

boolean supportsEntrySmartBlog()

Tests if entry smart blogging is available.

Returns:

true if entry smart blog is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsBlogLookup

boolean supportsBlogLookup()

Tests if blog lookup is supported.

Returns:

true if blog lookup is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsBlogQuery

boolean supportsBlogQuery()

Tests if blog query is supported.

Returns:

true if blog query is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsBlogSearch

boolean supportsBlogSearch()

Tests if blog search is supported.

Returns:

true if blog search is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsBlogAdmin

boolean supportsBlogAdmin()

Tests if blog administration is supported.

Returns:

true if blog administration is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsBlogNotification

boolean supportsBlogNotification()

Tests if blog notification is supported. Entries may be sent when Blog objects are created, deleted or updated. Notifications for entries within blogs are sent via the entry notification session.

Returns:

true if blog notification is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsBlogHierarchy

boolean supportsBlogHierarchy()

Tests if a blog hierarchy traversal is supported.

Returns:

true if a blog hierarchy traversal is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsBlogHierarchyDesign

boolean supportsBlogHierarchyDesign()

Tests if a blog hierarchy design is supported.

Returns:

true if a blog hierarchy design is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsBloggingBatch

boolean supportsBloggingBatch()

Tests if a blogging batch service is supported.

Returns:

true if a blogging batch service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

getEntryRecordTypes

TypeList getEntryRecordTypes()

Gets all the entry record types supported.

Returns:

the list of supported entry record types

Compliance:

mandatory - This method must be implemented.

supportsEntryRecordType

boolean supportsEntryRecordType(Type entryRecordType)

Tests if a given entry record type is supported.

Parameters:

entryRecordType - the entry type

Returns:

true if the entry record type is supported , false otherwise

Throws:

NullArgumentException - entryRecordType is null

Compliance:

mandatory - This method must be implemented.

getEntrySearchRecordTypes

TypeList getEntrySearchRecordTypes()

Gets all the entry search record types supported.

Returns:

the list of supported entry search record types

Compliance:

mandatory - This method must be implemented.

supportsEntrySearchRecordType

boolean supportsEntrySearchRecordType(Type entrySearchRecordType)

Tests if a given entry search type is supported.

Parameters:

entrySearchRecordType - the entry search type

Returns:

true if the entry search record type is supported , false otherwise

Throws:

NullArgumentException - entrySearchRecordType is null

Compliance:

mandatory - This method must be implemented.

getBlogRecordTypes

TypeList getBlogRecordTypes()

Gets all the blog record types supported.

Returns:

the list of supported blog record types

Compliance:

mandatory - This method must be implemented.

supportsBlogRecordType

boolean supportsBlogRecordType(Type blogRecordType)

Tests if a given blog record type is supported.

Parameters:

blogRecordType - the blog record type

Returns:

true if the blog record type is supported , false otherwise

Throws:

NullArgumentException - blogRecordType is null

Compliance:

mandatory - This method must be implemented.

getBlogSearchRecordTypes

TypeList getBlogSearchRecordTypes()

Gets all the blog search record types supported.

Returns:

the list of supported blog search record types

Compliance:

mandatory - This method must be implemented.

supportsBlogSearchRecordType

boolean supportsBlogSearchRecordType(Type blogSearchRecordType)

Tests if a given blog search record type is supported.

Parameters:

blogSearchRecordType - the blog search record type

Returns:

true if the blog search record type is supported , false otherwise

Throws:

NullArgumentException - blogSearchRecordType is null

Compliance:

mandatory - This method must be implemented.