org.osid.room.construction

Interface ProjectSearchSession

All Superinterfaces:

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

public interface ProjectSearchSession
extends ProjectQuerySession

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.

Method Summary

Methods

Modifier and Type	Method and 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 org.osid.room.construction.ProjectQuerySession

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

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

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.