org.osid.workflow

Interface OfficeQuerySession

All Superinterfaces:

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

All Known Subinterfaces:

OfficeSearchSession

public interface OfficeQuerySession
extends OsidSession

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

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canSearchOffices() Tests if this user can perform Office searches.
OfficeQuery	getOfficeQuery() Gets an office query.
OfficeList	getOfficesByQuery(OfficeQuery officeQuery) Gets a list of Offices matching the given 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

canSearchOffices

boolean canSearchOffices()

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

getOfficeQuery

OfficeQuery getOfficeQuery()

Gets an office query.

Returns:

the office query

Compliance:

mandatory - This method must be implemented.

getOfficesByQuery

OfficeList getOfficesByQuery(OfficeQuery officeQuery)
                             throws OperationFailedException,
                                    PermissionDeniedException

Gets a list of Offices matching the given office query.

Parameters:

officeQuery - the office query

Returns:

the returned OfficeList

Throws:

NullArgumentException - officeQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - officeQuery is not of this service

Compliance:

mandatory - This method must be implemented.