Interface ProjectSearchSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession, ProjectQuerySession

public interface ProjectSearchSession
extends ProjectQuerySession

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

Method Summary

Modifier and Type	Method	Description
ProjectQuery	getProjectQueryFromInspector(ProjectQueryInspector projectQueryInspector)	Gets a project query from an inspector.
ProjectSearchResults	getProjectsBySearch(ProjectQuery projectQuery, ProjectSearch projectSearch)	Gets the search results matching the given search.
ProjectSearch	getProjectSearch()	Gets a project search.
ProjectSearchOrder	getProjectSearchOrder()	Gets a project search order.

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.

Methods inherited from interface ProjectQuerySession

canSearchProjects, getCampus, getCampusId, getProjectQuery, getProjectsByQuery, useFederatedCampusView, useIsolatedCampusView

Modifier and Type	Method	Description
boolean	canSearchProjects()	Tests if this user can perform Project searches.
Campus	getCampus()	Gets the Campus associated with this session.
Id	getCampusId()	Gets the Campus Id associated with this session.
ProjectQuery	getProjectQuery()	Gets a project query.
ProjectList	getProjectsByQuery(ProjectQuery projectQuery)	Gets a list of Projects matching the given project query.
void	useFederatedCampusView()	Federates the view for methods in this session.
void	useIsolatedCampusView()	Isolates the view for methods in this session.

Method Details

getProjectSearch

ProjectSearch getProjectSearch()

Gets a project search.

Returns:

the project search

Compliance:

mandatory - This method must be implemented.

getProjectSearchOrder

ProjectSearchOrder getProjectSearchOrder()

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

Returns:

the project search order

Compliance:

mandatory - This method must be implemented.

getProjectsBySearch

ProjectSearchResults getProjectsBySearch(ProjectQuery projectQuery,
 ProjectSearch projectSearch)
                                  throws OperationFailedException,
PermissionDeniedException

Gets the search results matching the given search.

Parameters:

projectQuery - the project query

projectSearch - the project search

Returns:

the project search results

Throws:

NullArgumentException - projectQuery or projectSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - projectQuery or projectSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getProjectQueryFromInspector

ProjectQuery getProjectQueryFromInspector(ProjectQueryInspector projectQueryInspector)

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

Parameters:

projectQueryInspector - a query inspector

Returns:

the project query

Throws:

NullArgumentException - projectQueryInspector is null

UnsupportedException - projectQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.