OSID Logo
OSID Specifications
room package
Version 3.0.0
Release Candidate Preview
Interfaceosid.room.CampusSearchSession
Implementsosid.room.CampusQuerySession
Description

This session provides methods for searching Campus objects. The search query is constructed using the CampusQuery. The campus record Type also specifies the record for the campus query.

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

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

MethodgetCampusSearch
Description

Gets a campus search.

Returnosid.room.CampusSearchthe campus search
CompliancemandatoryThis method must be implemented.
MethodgetCampusSearchOrder
Description

Gets a campus search order. The CampusSearchOrder is supplied to a CampusSearch to specify the ordering of results.

Returnosid.room.CampusSearchOrderthe campus search order
CompliancemandatoryThis method must be implemented.
MethodgetCampusesBySearch
Description

Gets the search results matching the given search.

Parametersosid.room.CampusQuerycampusQuerythe campus query
osid.room.CampusSearchcampusSearchthe campus search
Returnosid.room.CampusSearchResultsthe campus search results
ErrorsNULL_ARGUMENT campusQuery or campusSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED campusQuery or campusSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetCampusQueryFromInspector
Description

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

Parametersosid.room.CampusQueryInspectorcampusQueryInspectora query inspector
Returnosid.room.CampusQuerythe entry query
ErrorsNULL_ARGUMENT campusQueryInspector is null
UNSUPPORTED campusQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.