org.osid.inquiry

Interface InquestQuerySession

All Superinterfaces:

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

All Known Subinterfaces:

InquestSearchSession

public interface InquestQuerySession
extends OsidSession

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

Inquests may have a query record indicated by their respective record types. The query record is accessed via the InquestQuery.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canSearchInquests() Tests if this user can perform Inquest searches.
InquestQuery	getInquestQuery() Gets an inquest query.
InquestList	getInquestsByQuery(InquestQuery inquestQuery) Gets a list of Inquests matching the given inquest 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

canSearchInquests

boolean canSearchInquests()

Tests if this user can perform Inquest 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 not offer lookup operations to unauthorized users.

Returns:

false if search methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getInquestQuery

InquestQuery getInquestQuery()

Gets an inquest query.

Returns:

the inquest query

Compliance:

mandatory - This method must be implemented.

getInquestsByQuery

InquestList getInquestsByQuery(InquestQuery inquestQuery)
                               throws OperationFailedException,
                                      PermissionDeniedException

Gets a list of Inquests matching the given inquest query.

Parameters:

inquestQuery - the inquest query

Returns:

the returned InquestList

Throws:

NullArgumentException - inquestQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - inquestQuery is not of this service

Compliance:

mandatory - This method must be implemented.