org.osid.room

Interface CampusSearchSession

All Superinterfaces:

java.lang.AutoCloseable, CampusQuerySession, java.io.Closeable, OsidSession

public interface CampusSearchSession
extends CampusQuerySession

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.

Method Summary

Methods

Modifier and Type	Method and Description
CampusSearchResults	getCampusesBySearch(CampusQuery campusQuery, CampusSearch campusSearch) Gets the search results matching the given search.
CampusQuery	getCampusQueryFromInspector(CampusQueryInspector campusQueryInspector) Gets an entry query from an inspector.
CampusSearch	getCampusSearch() Gets a campus search.
CampusSearchOrder	getCampusSearchOrder() Gets a campus search order.

Methods inherited from interface org.osid.room.CampusQuerySession

canSearchCampuses, getCampusesByQuery, getCampusQuery

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getCampusSearch

CampusSearch getCampusSearch()

Gets a campus search.

Returns:

the campus search

Compliance:

mandatory - This method must be implemented.

getCampusSearchOrder

CampusSearchOrder getCampusSearchOrder()

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

Returns:

the campus search order

Compliance:

mandatory - This method must be implemented.

getCampusesBySearch

CampusSearchResults getCampusesBySearch(CampusQuery campusQuery,
                                      CampusSearch campusSearch)
                                        throws OperationFailedException,
                                               PermissionDeniedException

Gets the search results matching the given search.

Parameters:

campusQuery - the campus query

campusSearch - the campus search

Returns:

the campus search results

Throws:

NullArgumentException - campusQuery or campusSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - campusQuery or campusSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getCampusQueryFromInspector

CampusQuery getCampusQueryFromInspector(CampusQueryInspector campusQueryInspector)

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

Parameters:

campusQueryInspector - a query inspector

Returns:

the entry query

Throws:

NullArgumentException - campusQueryInspector is null

UnsupportedException - campusQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.