OSID Logo
OSID Specifications
forum package
Version 3.0.0
Release Candidate Preview
Interfaceosid.forum.ForumQuerySession
Implementsosid.OsidSession
Description

This session provides methods for searching Forum objects. The search query is constructed using the ForumQuery. The forum record Type also specifies the record for the forum query.

Forums may have a query record indicated by their respective record types. The query record is accessed via the ForumQuery. The returns in this session may not be cast directly to these interfaces.

MethodcanSearchForums
Description

Tests if this user can perform Forum searches. A return of true does not guarantee successful authorization. A return of false indicates that it is known all 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 search operations to unauthorized users.

Returnboolean false if search methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetForumQuery
Description

Gets a forum query.

Returnosid.forum.ForumQuerythe forum query
CompliancemandatoryThis method must be implemented.
MethodgetForumsByQuery
Description

Gets a list of Forums matching the given search.

Parametersosid.forum.ForumQueryforumQuerythe forum query
Returnosid.forum.ForumListthe returned ForumList
ErrorsNULL_ARGUMENT forumQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED forumQuery is not of this service
CompliancemandatoryThis method must be implemented.