org.osid.profile

Interface ProfileQuerySession

All Superinterfaces:

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

All Known Subinterfaces:

ProfileSearchSession

public interface ProfileQuerySession
extends OsidSession

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

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canSearchProfiles() Tests if this user can perform Profile searches.
ProfileQuery	getProfileQuery() Gets a profile query.
ProfileList	getProfilesByQuery(ProfileQuery profileQuery) Gets a list of Profiles matching the given profile query.

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

canSearchProfiles

boolean canSearchProfiles()

Tests if this user can perform Profile searches. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer search operations to unauthorized users.

Returns:

false if search methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getProfileQuery

ProfileQuery getProfileQuery()

Gets a profile query.

Returns:

a profile query

Compliance:

mandatory - This method must be implemented.

getProfilesByQuery

ProfileList getProfilesByQuery(ProfileQuery profileQuery)
                               throws OperationFailedException,
                                      PermissionDeniedException

Gets a list of Profiles matching the given profile query.

Parameters:

profileQuery - the profile query

Returns:

the returned ProfileList

Throws:

NullArgumentException - profileQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - profileQuery is not of this service

Compliance:

mandatory - This method must be implemented.