Interface ProfileItemSearchSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession, ProfileItemQuerySession

public interface ProfileItemSearchSession
extends ProfileItemQuerySession

This session provides methods for searching ProfileItems . The search query is constructed using the ProfileItemQuery . The profile item record Type also specifies the query record for the profile item query.

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

This session defines views that offer differing behaviors for searching.

• federated profile view: searches include profile item in profiles of which this profile is an ancestor in the profile hierarchy
• isolated profile view: searches are restricted to profile items in this profile

Profile items may have a profie item query record indicated by their respective record types. The profile item query record is accessed via the ProfileItemQuery .

Method Summary

Modifier and Type	Method	Description
ProfileItemQuery	getProfileItemQueryFromInspector(ProfileItemQueryInspector profileItemQueryInspector)	Gets a profile item query from an inspector.
ProfileItemSearchResults	getProfileItemsBySearch(ProfileItemQuery profileItemQuery, ProfileItemSearch profileItemSearch)	Gets the search results matching the given search query using the given search.
ProfileItemSearch	getProfileItemSearch()	Gets a profile item search.
ProfileItemSearchOrder	getProfileItemSearchOrder()	Gets a profile item 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 ProfileItemQuerySession

canSearchProfileItems, getProfile, getProfileId, getProfileItemQuery, getProfileItemsByQuery, useFederatedProfileView, useIsolatedProfileView

Modifier and Type	Method	Description
boolean	canSearchProfileItems()	Tests if this user can perform ProfileItem searches.
Profile	getProfile()	Gets the Profile associated with this session.
Id	getProfileId()	Gets the Profile Id associated with this session.
ProfileItemQuery	getProfileItemQuery()	Gets a profile item query.
ProfileItemList	getProfileItemsByQuery(ProfileItemQuery profileItemQuery)	Gets a list of ProfileItems matching the given profile item query interface.
void	useFederatedProfileView()	Federates the view for methods in this session.
void	useIsolatedProfileView()	Isolates the view for methods in this session.

Method Details

getProfileItemSearch

ProfileItemSearch getProfileItemSearch()

Gets a profile item search.

Returns:

the profile item search

Compliance:

mandatory - This method must be implemented.

getProfileItemSearchOrder

ProfileItemSearchOrder getProfileItemSearchOrder()

Gets a profile item search order. The ProfileItemSearchOrder is supplied to a ProfileItemSearch to specify the ordering of results.

Returns:

the profile item search order

Compliance:

mandatory - This method must be implemented.

getProfileItemsBySearch

ProfileItemSearchResults getProfileItemsBySearch(ProfileItemQuery profileItemQuery,
 ProfileItemSearch profileItemSearch)
                                          throws OperationFailedException,
PermissionDeniedException

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

Parameters:

profileItemQuery - the profile item query

profileItemSearch - the profile item search

Returns:

the returned search results

Throws:

NullArgumentException - profileItemQuery or profileItemSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - profileItemSearch or profileItemQuery is not of this service

Compliance:

mandatory - This method must be implemented.

getProfileItemQueryFromInspector

ProfileItemQuery getProfileItemQueryFromInspector(ProfileItemQueryInspector profileItemQueryInspector)

Gets a profile item query from an inspector. The inspector is available from an ProfileItemSearchResults .

Parameters:

profileItemQueryInspector - a profile item query inspector

Returns:

the profile item query

Throws:

NullArgumentException - profileItemQueryInspector is null

UnsupportedException - profileItemQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.