org.osid.profile

Interface ProfileSearchSession

All Superinterfaces:

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

public interface ProfileSearchSession
extends ProfileQuerySession

This session provides methods for searching among Profile objects. The search query is constructed using the ProfileQuery.

getProfilesByQuery() is the basic search method and returns a list of Profile objects.A more advanced search may be performed with getProfilesBySearch(). It accepts a ProfileSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getProfilesBySearch() returns a ProfileSearchResults that can be used to access the resulting ProfileList or be used to perform a search within the result set through ProfileSearch.

Profiles may have a profile query record indicated by their respective record types. The profile query record is accessed via the ProfileQuery.

Method Summary

Methods

Modifier and Type	Method and Description
ProfileQuery	getProfileQueryFromInspector(ProfileQueryInspector profileQueryInspector) Gets a profile query from an inspector.
ProfileSearchResults	getProfilesBySearch(ProfileQuery profileQuery, ProfileSearch profileSearch) Gets the search results matching the given search query using the given search.
ProfileSearch	getProfileSearch() Gets a profile search.
ProfileSearchOrder	getProfileSearchOrder() Gets a profile search order.

Methods inherited from interface org.osid.profile.ProfileQuerySession

canSearchProfiles, getProfileQuery, getProfilesByQuery

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

getProfileSearch

ProfileSearch getProfileSearch()

Gets a profile search.

Returns:

a profile search

Compliance:

mandatory - This method must be implemented.

getProfileSearchOrder

ProfileSearchOrder getProfileSearchOrder()

Gets a profile search order. The ProfileSearchOrder is supplied to a ProfileSearch to specify the ordering of results.

Returns:

the profile search order

Compliance:

mandatory - This method must be implemented.

getProfilesBySearch

ProfileSearchResults getProfilesBySearch(ProfileQuery profileQuery,
                                       ProfileSearch profileSearch)
                                         throws OperationFailedException,
                                                PermissionDeniedException

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

Parameters:

profileQuery - the profile query

profileSearch - the profile search

Returns:

the search results

Throws:

NullArgumentException - profileQuery or profileSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - profileQuery or profileSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getProfileQueryFromInspector

ProfileQuery getProfileQueryFromInspector(ProfileQueryInspector profileQueryInspector)

Gets a profile query from an inspector. The inspector is available from an ProfileSearchResults.

Parameters:

profileQueryInspector - a profile query inspector

Returns:

the profile query

Throws:

NullArgumentException - profileQueryInspector is null

UnsupportedException - profileQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.