org.osid.tracking

Interface FrontOfficeQuerySession

All Superinterfaces:

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

All Known Subinterfaces:

FrontOfficeSearchSession

public interface FrontOfficeQuerySession
extends OsidSession

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

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canSearchFrontOffices() Tests if this user can perform FrontOffice searches.
FrontOfficeQuery	getFrontOfficeQuery() Gets a front office query.
FrontOfficeList	getFrontOfficesByQuery(FrontOfficeQuery frontOfficeQuery) Gets a list of FrontOffices matching the given fromt office 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

canSearchFrontOffices

boolean canSearchFrontOffices()

Tests if this user can perform FrontOffice 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.

getFrontOfficeQuery

FrontOfficeQuery getFrontOfficeQuery()

Gets a front office query.

Returns:

the front office query

Compliance:

mandatory - This method must be implemented.

getFrontOfficesByQuery

FrontOfficeList getFrontOfficesByQuery(FrontOfficeQuery frontOfficeQuery)
                                       throws OperationFailedException,
                                              PermissionDeniedException

Gets a list of FrontOffices matching the given fromt office query.

Parameters:

frontOfficeQuery - the front office query

Returns:

the returned FrontOfficeList

Throws:

NullArgumentException - frontOfficeQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - frontOfficeQuery is not of this service

Compliance:

mandatory - This method must be implemented.