OSID Logo
OSID Specifications
room construction package
Version 3.0.0
Release Candidate Preview
Interfaceosid.room.construction.ProjectSearchSession
Implementsosid.room.construction.ProjectQuerySession
Description

This session provides methods for searching Project objects. The search query is constructed using the ProjectQuery. The project record Type also specifies the record for the project query.

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

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

MethodgetProjectSearch
Description

Gets a project search.

Returnosid.room.construction.ProjectSearchthe project search
CompliancemandatoryThis method must be implemented.
MethodgetProjectSearchOrder
Description

Gets a project search order. The ProjectSearchOrder is supplied to a ProjectSearch to specify the ordering of results.

Returnosid.room.construction.ProjectSearchOrderthe project search order
CompliancemandatoryThis method must be implemented.
MethodgetProjectsBySearch
Description

Gets the search results matching the given search.

Parametersosid.room.construction.ProjectQueryprojectQuerythe project query
osid.room.construction.ProjectSearchprojectSearchthe project search
Returnosid.room.construction.ProjectSearchResultsthe project search results
ErrorsNULL_ARGUMENT projectQuery or projectSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED projectQuery or projectSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetProjectQueryFromInspector
Description

Gets a project query from an inspector. The inspector is available from a ProjectSearchResults.

Parametersosid.room.construction.ProjectQueryInspectorprojectQueryInspectora query inspector
Returnosid.room.construction.ProjectQuerythe project query
ErrorsNULL_ARGUMENT projectQueryInspector is null
UNSUPPORTED projectQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.