public interface ForumProfile extends OsidProfile
The reply profile describes the interoperability among forum services.
Modifier and Type | Method and Description |
---|---|
TypeList |
getForumRecordTypes()
Gets the supported
Forum record types. |
TypeList |
getForumSearchRecordTypes()
Gets the supported forum search record types.
|
TypeList |
getPostRecordTypes()
Gets the supported
Post record types. |
TypeList |
getPostSearchRecordTypes()
Gets the supported post search record types.
|
TypeList |
getReplyRecordTypes()
Gets the supported
Reply record types. |
TypeList |
getReplySearchRecordTypes()
Gets the supported reply search record types.
|
boolean |
supportsForumAdmin()
Tests for the availability of a forum administrative service for
creating and deleting forums.
|
boolean |
supportsForumBatch()
Tests if forum batch service is available.
|
boolean |
supportsForumHierarchy()
Tests for the availability of a forum hierarchy traversal service.
|
boolean |
supportsForumHierarchyDesign()
Tests for the availability of a forum hierarchy design service.
|
boolean |
supportsForumLookup()
Tests for the availability of an forum lookup service.
|
boolean |
supportsForumNotification()
Tests for the availability of a forum notification service.
|
boolean |
supportsForumQuery()
Tests if querying forums is available.
|
boolean |
supportsForumRecordType(Type forumRecordType)
Tests if the given
Forum record type is supported. |
boolean |
supportsForumSearch()
Tests if searching for forums is available.
|
boolean |
supportsForumSearchRecordType(Type forumSearchRecordType)
Tests if the given forum search record type is supported.
|
boolean |
supportsPostAdmin()
Tests for the availability of a post administrative service for
creating and deleting posts.
|
boolean |
supportsPostForum()
Tests if a post to forum lookup session is available.
|
boolean |
supportsPostForumAssignment()
Tests if a post to forum assignment session is available.
|
boolean |
supportsPostLookup()
Tests for the availability of an post lookup service.
|
boolean |
supportsPostNotification()
Tests for the availability of a post notification service.
|
boolean |
supportsPostQuery()
Tests if querying posts is available.
|
boolean |
supportsPostRecordType(Type postRecordType)
Tests if the given
Post record type is supported. |
boolean |
supportsPostSearch()
Tests if searching for posts is available.
|
boolean |
supportsPostSearchRecordType(Type postSearchRecordType)
Tests if the given post search record type is supported.
|
boolean |
supportsPostSmartForum()
Tests if a post smart foruming session is available.
|
boolean |
supportsReplyAdmin()
Tests if searching for replies is available.
|
boolean |
supportsReplyLookup()
Tests for the availability of a reply lookup service.
|
boolean |
supportsReplyNotification()
Tests if reply notification is available.
|
boolean |
supportsReplyRecordType(Type replyRecordType)
Tests if the given
Reply record type is supported. |
boolean |
supportsReplySearchRecordType(Type replySearchRecordType)
Tests if the given reply search record type is supported.
|
boolean |
supportsVisibleFederation()
Tests if any post federation is exposed.
|
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
boolean supportsVisibleFederation()
true
if visible federation is supported,
false
otherwisemandatory
- This method must be implemented. boolean supportsPostLookup()
true
if post lookup is available, false
otherwisemandatory
- This method must be implemented. boolean supportsPostQuery()
true
if post query is available, false
otherwisemandatory
- This method must be implemented. boolean supportsPostSearch()
true
if post search is available, false
otherwisemandatory
- This method must be implemented. boolean supportsPostAdmin()
true
if post administration is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsPostNotification()
true
if post notification is available,
false
otherwisemandatory
- This method must be implemented in all
providers. boolean supportsPostForum()
true
if post forum lookup session is supported,
false
otherwisemandatory
- This method must be implemented. boolean supportsPostForumAssignment()
true
if post forum assignment is supported,
false
otherwisemandatory
- This method must be implemented. boolean supportsPostSmartForum()
true
if post smart foruming is supported,
false
otherwisemandatory
- This method must be implemented. boolean supportsReplyLookup()
true
if reply lookup is available, false
otherwisemandatory
- This method must be implemented. boolean supportsReplyAdmin()
true
if reply search is available, false
otherwisemandatory
- This method must be implemented. boolean supportsReplyNotification()
true
if reply notification is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsForumLookup()
true
if forum lookup is available, false
otherwisemandatory
- This method must be implemented. boolean supportsForumQuery()
true
if forum query is available, false
otherwisemandatory
- This method must be implemented. boolean supportsForumSearch()
true
if forum search is available, false
otherwisemandatory
- This method must be implemented. boolean supportsForumAdmin()
true
if forum administration is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsForumNotification()
true
if forum notification is available,
false
otherwisemandatory
- This method must be implemented in all
providers. boolean supportsForumHierarchy()
true
if forum hierarchy traversal is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsForumHierarchyDesign()
true
if forum hierarchy design is available,
false
otherwisemandatory
- This method must be implemented in all
providers. boolean supportsForumBatch()
true
if forum batch service is available,
false
otherwisemandatory
- This method must be implemented. TypeList getPostRecordTypes()
Post
record types.mandatory
- This method must be implemented. boolean supportsPostRecordType(Type postRecordType)
Post
record type is supported.postRecordType
- a Type
indicating a Post
record type true
if the given Type
is
supported, false
otherwiseNullArgumentException
- postRecordType
is null
mandatory
- This method must be implemented. TypeList getPostSearchRecordTypes()
mandatory
- This method must be implemented. boolean supportsPostSearchRecordType(Type postSearchRecordType)
postSearchRecordType
- a Type
indicating a post
record type true
if the given Type
is
supported, false
otherwiseNullArgumentException
- postSearchRecordType
is null
mandatory
- This method must be implemented. TypeList getReplyRecordTypes()
Reply
record types.mandatory
- This method must be implemented. boolean supportsReplyRecordType(Type replyRecordType)
Reply
record type is supported.replyRecordType
- a Type
indicating a
Reply
record type true
if the given Type
is
supported, false
otherwiseNullArgumentException
- replyRecordType
is null
mandatory
- This method must be implemented. TypeList getReplySearchRecordTypes()
mandatory
- This method must be implemented. boolean supportsReplySearchRecordType(Type replySearchRecordType)
replySearchRecordType
- a Type
indicating a reply
record type true
if the given Type
is
supported, false
otherwiseNullArgumentException
- replySearchRecordType
is null
mandatory
- This method must be implemented. TypeList getForumRecordTypes()
Forum
record types.mandatory
- This method must be implemented. boolean supportsForumRecordType(Type forumRecordType)
Forum
record type is supported.forumRecordType
- a Type
indicating a
Forum
record type true
if the given Type
is
supported, false
otherwiseNullArgumentException
- forumRecordType
is null
mandatory
- This method must be implemented. TypeList getForumSearchRecordTypes()
mandatory
- This method must be implemented. boolean supportsForumSearchRecordType(Type forumSearchRecordType)
forumSearchRecordType
- a Type
indicating a forum
record type true
if the given Type
is
supported, false
otherwiseNullArgumentException
- forumSearchRecordType
is null
mandatory
- This method must be implemented.