Interface ParticipantSearchSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession, ParticipantQuerySession

public interface ParticipantSearchSession
extends ParticipantQuerySession

This session provides methods for searching Participants. The search query is constructed using the ParticipantQuery. The participant record Type also specifies the record for the participant query.

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

This session defines views that offer differing behaviors for searching.

• federated catalogue view: searches include participants in catalogues of which this catalogue is an ancestor in the catalogue hierarchy
• isolated catalogue view: searches are restricted to participants in this catalogue

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

Method Summary

Modifier and Type	Method	Description
ParticipantQuery	getParticipantQueryFromInspector(ParticipantQueryInspector participantQueryInspector)	Gets the participant query inspector.
ParticipantSearchResults	getParticipantsBySearch(ParticipantQuery participantQuery, ParticipantSearch participantSearch)	Gets the search results matching the given search.
ParticipantSearch	getParticipantSearch()	Gets a participant search.
ParticipantSearchOrder	getParticipantSearchOrder()	Gets a participant 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 ParticipantQuerySession

canSearchParticipants, getCatalogue, getCatalogueId, getParticipantQuery, getParticipantsByQuery, useFederatedCatalogueView, useIsolatedCatalogueView

Modifier and Type	Method	Description
boolean	canSearchParticipants()	Tests if this user can perform Participant searches.
Catalogue	getCatalogue()	Gets the Catalogue associated with this session.
Id	getCatalogueId()	Gets the Catalogue Id associated with this session.
ParticipantQuery	getParticipantQuery()	Gets a participant query.
ParticipantList	getParticipantsByQuery(ParticipantQuery participantQuery)	Gets a list of participants matching the given participant query.
void	useFederatedCatalogueView()	Federates the view for methods in this session.
void	useIsolatedCatalogueView()	Isolates the view for methods in this session.

Method Details

getParticipantSearch

ParticipantSearch getParticipantSearch()

Gets a participant search.

Returns:

the participant search

Compliance:

mandatory - This method must be implemented.

getParticipantSearchOrder

ParticipantSearchOrder getParticipantSearchOrder()

Gets a participant search order. The ParticipantSearchOrder is supplied to a ParticipantSearch to specify the ordering of results.

Returns:

the participant search order

Compliance:

mandatory - This method must be implemented.

getParticipantsBySearch

ParticipantSearchResults getParticipantsBySearch(ParticipantQuery participantQuery,
 ParticipantSearch participantSearch)
                                          throws OperationFailedException,
PermissionDeniedException

Gets the search results matching the given search.

Parameters:

participantQuery - the participant query

participantSearch - the participant search

Returns:

the search results

Throws:

NullArgumentException - participantQuery or participantSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - participantQuery or participantSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getParticipantQueryFromInspector

ParticipantQuery getParticipantQueryFromInspector(ParticipantQueryInspector participantQueryInspector)

Gets the participant query inspector.

Parameters:

participantQueryInspector - a participant query inspector

Returns:

the participant query

Throws:

NullArgumentException - participantQueryInspector is null

UnsupportedException - participantQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.