org.osid.profile

Interface ProfileEntrySearchSession

All Superinterfaces:

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

public interface ProfileEntrySearchSession
extends ProfileEntryQuerySession

This session provides methods for searching ProfileEntry objects. 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 a ancestor in the profile hierarchy
• isolated profile view: searches are restricted to entries in this Profile

Method Summary

Methods

Modifier and Type	Method and 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 org.osid.profile.ProfileEntryQuerySession

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

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

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.