OSID Logo
OSID Specifications
forum package
Version 3.0.0
Release Candidate Preview
Interfaceosid.forum.PostSearchSession
Implementsosid.forum.PostQuerySession
Description

This session provides methods for searching Post objects. The search query is constructed using the PostQuery. The post record Type also specifies the record for the post query.

getPostsByQuery() is the basic search method and returns a list of Post elements. A more advanced search may be performed with getPostsBySearch(). It accepts a PostSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getPostsBySearch() returns a PostSearchResults that can be used to access the resulting PostList or be used to perform a search within the result set through PostSearch.

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

MethodgetPostSearch
Description

Gets a post search.

Returnosid.forum.PostSearchthe post search
CompliancemandatoryThis method must be implemented.
MethodgetPostSearchOrder
Description

Gets a post search order. The PostSearchOrder is supplied to a PostSearch to specify the ordering of results.

Returnosid.forum.PostSearchOrderthe post search order
CompliancemandatoryThis method must be implemented.
MethodgetPostsBySearch
Description

Gets the search results matching the given search.

Parametersosid.forum.PostQuerypostQuerythe post query
osid.forum.PostSearchpostSearchthe post search
Returnosid.forum.PostSearchResultsthe post search results
ErrorsNULL_ARGUMENT postQuery or postSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED postQuery or postSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetPostQueryFromInspector
Description

Gets an entry query from an inspector. The inspector is available from an PostSearchResults.

Parametersosid.forum.PostQueryInspectorpostQueryInspectora query inspector
Returnosid.forum.PostQuerythe entry query
ErrorsNULL_ARGUMENT postQueryInspector is null
UNSUPPORTED postQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.