Interface CampusSearchSession

All Superinterfaces:

AutoCloseable, CampusQuerySession, Closeable, OsidSession, OsidSession

public interface CampusSearchSession
extends CampusQuerySession

This session provides methods for searching Campuses. 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

Modifier and Type	Method	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 CampusQuerySession

canSearchCampuses, getCampusesByQuery, getCampusQuery

Modifier and Type	Method	Description
boolean	canSearchCampuses()	Tests if this user can perform Campus searches.
CampusList	getCampusesByQuery(CampusQuery campusQuery)	Gets a list of Campuses matching the given campus query.
CampusQuery	getCampusQuery()	Gets a campus query.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

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

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

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.