Interface BloggingProfile
- All Superinterfaces:
OsidProfile, Sourceable
- All Known Subinterfaces:
BloggingManager, BloggingProxyManager
The entry profile describes interoperability among entry services.
-
Method Summary
Modifier and TypeMethodDescriptionGets all the blog record types supported.Gets all the blog search record types supported.Gets all the entry record types supported.Gets all the entry search record types supported.booleanTests if blog administration is supported.booleanTests if sending entries is supported.booleanTests if a blogging batch service is supported.booleanTests if a blog hierarchy traversal is supported.booleanTests if a blog hierarchy design is supported.booleanTests if blog lookup is supported.booleanTests if blog notification is supported.booleanTests if blog query is supported.booleansupportsBlogRecordType(Type blogRecordType) Tests if a given blog record type is supported.booleanTests if blog search is supported.booleansupportsBlogSearchRecordType(Type blogSearchRecordType) Tests if a given blog search record type is supported.booleanTests if creating, updating and deleting entries is supported.booleanTests if retrieving mappings of entry and blogs is supported.booleanTests if managing mappings of entries and blogs is supported.booleanTests if entry lookup is supported.booleanTests if entry notification is supported.booleanTests if entry query is supported.booleansupportsEntryRecordType(Type entryRecordType) Tests if a given entry record type is supported.booleanTests if entry search is supported.booleansupportsEntrySearchRecordType(Type entrySearchRecordType) Tests if a given entry search type is supported.booleanTests if entry smart blogging is available.booleanTests if federation is visible.Methods inherited from interface OsidProfile
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordTypeModifier and TypeMethodDescriptionGets this service branch.Gets theBranch Idrepresenting this service branch.Gets a description of this service implementation.Gets a display name for this service implementation.getId()Gets an identifier for this service implementation.Gets the locales supported in this service.Gets the proxy recordTypessupported in this service.Gets the date this service implementation was released.Gets the version of this service implementation.booleanTest for support of a journal branching service.booleanTest for support of a journaling rollback service.booleansupportsOSIDVersion(Version version) Test for support of an OSID specification version.booleansupportsProxyRecordType(Type proxyRecordType) Test for support of a proxy type.Methods inherited from interface Sourceable
getBranding, getBrandingIds, getLicense, getProvider, getProviderIdModifier and TypeMethodDescriptionGets a branding, such as an image or logo, expressed using theAssetinterface.Gets the branding assetIds.Gets the terms of usage.Gets theResourcerepresenting the provider.Gets theIdof the provider.
-
Method Details
-
supportsVisibleFederation
boolean supportsVisibleFederation()Tests if federation is visible.- Returns:
trueif visible federation is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsBlogging
boolean supportsBlogging()Tests if sending entries is supported.- Returns:
trueif entry sending is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsEntryLookup
boolean supportsEntryLookup()Tests if entry lookup is supported.- Returns:
trueif entry lookup is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsEntryQuery
boolean supportsEntryQuery()Tests if entry query is supported.- Returns:
trueif entry query is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsEntrySearch
boolean supportsEntrySearch()Tests if entry search is supported.- Returns:
trueif entry search is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsEntryAdmin
boolean supportsEntryAdmin()Tests if creating, updating and deleting entries is supported.- Returns:
trueif entry administration is supported,falseotherwise- 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:
trueif entry notification is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsEntryBlog
boolean supportsEntryBlog()Tests if retrieving mappings of entry and blogs is supported.- Returns:
trueif entry blog mapping retrieval is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsEntryBlogAssignment
boolean supportsEntryBlogAssignment()Tests if managing mappings of entries and blogs is supported.- Returns:
trueif entry blog assignment is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsEntrySmartBlog
boolean supportsEntrySmartBlog()Tests if entry smart blogging is available.- Returns:
trueif entry smart blog is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsBlogLookup
boolean supportsBlogLookup()Tests if blog lookup is supported.- Returns:
trueif blog lookup is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsBlogQuery
boolean supportsBlogQuery()Tests if blog query is supported.- Returns:
trueif blog query is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsBlogSearch
boolean supportsBlogSearch()Tests if blog search is supported.- Returns:
trueif blog search is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsBlogAdmin
boolean supportsBlogAdmin()Tests if blog administration is supported.- Returns:
trueif blog administration is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsBlogNotification
boolean supportsBlogNotification()Tests if blog notification is supported. Entries may be sent whenBlogobjects are created, deleted or updated. Notifications for entries within blogs are sent via the entry notification session.- Returns:
trueif blog notification is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsBlogHierarchy
boolean supportsBlogHierarchy()Tests if a blog hierarchy traversal is supported.- Returns:
trueif a blog hierarchy traversal is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsBlogHierarchyDesign
boolean supportsBlogHierarchyDesign()Tests if a blog hierarchy design is supported.- Returns:
trueif a blog hierarchy design is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsBloggingBatch
boolean supportsBloggingBatch()Tests if a blogging batch service is supported.- Returns:
trueif a blogging batch service is supported,falseotherwise- 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
Tests if a given entry record type is supported.- Parameters:
entryRecordType- the entry type- Returns:
trueif the entry record type is supported,falseotherwise- Throws:
NullArgumentException-entryRecordTypeisnull- 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
Tests if a given entry search type is supported.- Parameters:
entrySearchRecordType- the entry search type- Returns:
trueif the entry search record type is supported,falseotherwise- Throws:
NullArgumentException-entrySearchRecordTypeisnull- 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
Tests if a given blog record type is supported.- Parameters:
blogRecordType- the blog record type- Returns:
trueif the blog record type is supported,falseotherwise- Throws:
NullArgumentException-blogRecordTypeisnull- 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
Tests if a given blog search record type is supported.- Parameters:
blogSearchRecordType- the blog search record type- Returns:
trueif the blog search record type is supported,falseotherwise- Throws:
NullArgumentException-blogSearchRecordTypeisnull- Compliance:
mandatory- This method must be implemented.
-