Interface ProfileEntrySearchSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession, ProfileEntryQuerySession

public interface ProfileEntrySearchSession
extends ProfileEntryQuerySession

This session provides methods for searching ProfileEntries . The search query is constructed using the ProfileEntryQuery .

getProfileEntriesByQuery() is the basic search method and returns a list of ProfileEntries . A more advanced search may be performed with getProfileEntriesBySearch() .It accepts an ProfileEntrySearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getProfileEntriesBySearch() returns an ProfileEntrySearchResults that can be used to access the resulting ProfileEntryList or be used to perform a search within the result set through ProfileEntrySearch .

This session defines views that offer differing behaviors for searching.

• federated profile view: searches include profile entries in Profiles of which this profile is an ancestor in the profile hierarchy
• isolated profile view: searches are restricted to entries in this Profile

Method Summary

Modifier and Type	Method	Description
ProfileEntrySearchResults	getProfileEntriesBySearch(ProfileEntryQuery profileEntryQuery, ProfileEntrySearch profileEntrySearch)	Gets the search results matching the given search query using the given search.
ProfileEntryQuery	getProfileEntryQueryFromInspector(ProfileEntryQueryInspector profileEntryQueryInspector)	Gets a profile entry query from an inspector.
ProfileEntrySearch	getProfileEntrySearch()	Gets a profile entry search.
ProfileEntrySearchOrder	getProfileEntrySearchOrder()	Gets a profile entry 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 ProfileEntryQuerySession

canSearchProfileEntries, getProfile, getProfileEntriesByQuery, getProfileEntryQuery, getProfileId, useExplicitProfileEntryView, useFederatedProfileView, useImplicitProfileEntryView, useIsolatedProfileView

Modifier and Type	Method	Description
boolean	canSearchProfileEntries()	Tests if this user can perform profile entry searches.
Profile	getProfile()	Gets the Profile associated with this session.
ProfileEntryList	getProfileEntriesByQuery(ProfileEntryQuery profileEntryQuery)	Gets a list of ProfileEntries matching the given query
ProfileEntryQuery	getProfileEntryQuery()	Gets a profile entry query.
Id	getProfileId()	Gets the Profile Id associated with this session.
void	useExplicitProfileEntryView()	Sets the view for methods in this session to explicit proffile entries.
void	useFederatedProfileView()	Federates the view for methods in this session.
void	useImplicitProfileEntryView()	Sets the view for methods in this session to implicit profile entry.
void	useIsolatedProfileView()	Isolates the view for methods in this session.

Method Details

getProfileEntrySearch

ProfileEntrySearch getProfileEntrySearch()

Gets a profile entry search.

Returns:

the profile entry search

Compliance:

mandatory - This method must be implemented.

getProfileEntrySearchOrder

ProfileEntrySearchOrder getProfileEntrySearchOrder()

Gets a profile entry search order. The ProfileEntrySearchOrder is supplied to an ProfileEntrySearch to specify the ordering of results.

Returns:

the profile entry search order

Compliance:

mandatory - This method must be implemented.

getProfileEntriesBySearch

ProfileEntrySearchResults getProfileEntriesBySearch(ProfileEntryQuery profileEntryQuery,
 ProfileEntrySearch profileEntrySearch)
                                             throws OperationFailedException,
PermissionDeniedException

Gets the search results matching the given search query using the given search.

Parameters:

profileEntryQuery - the profile entry query

profileEntrySearch - the profile entry search

Returns:

the returned search results

Throws:

NullArgumentException - profileEntryQuery or profileEntrySearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - profileEntryQuery or profileEntrySearch is not of this service

Compliance:

mandatory - This method must be implemented.

getProfileEntryQueryFromInspector

ProfileEntryQuery getProfileEntryQueryFromInspector(ProfileEntryQueryInspector profileEntryQueryInspector)

Gets a profile entry query from an inspector. The inspector is available from an PofileEntrySearchResults .

Parameters:

profileEntryQueryInspector - a profile entry query inspector

Returns:

the profile entry query

Throws:

NullArgumentException - profileEntryQueryInspector is null

UnsupportedException - pofileEntryQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.