org.osid.installation

Interface DepotQuerySession

All Superinterfaces:

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

All Known Subinterfaces:

DepotSearchSession

public interface DepotQuerySession
extends OsidSession

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

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canSearchDepots() Tests if this user can perform Depot searches.
DepotQuery	getDepotQuery() Gets a depot query.
DepotList	getDepotsByQuery(DepotQuery depotQuery) Gets a list of Depot objects matching the given depot 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

canSearchDepots

boolean canSearchDepots()

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

getDepotQuery

DepotQuery getDepotQuery()

Gets a depot query.

Returns:

a depot query

Compliance:

mandatory - This method must be implemented.

getDepotsByQuery

DepotList getDepotsByQuery(DepotQuery depotQuery)
                           throws OperationFailedException,
                                  PermissionDeniedException

Gets a list of Depot objects matching the given depot query.

Parameters:

depotQuery - the depot query

Returns:

the returned DepotList

Throws:

NullArgumentException - depotQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - depotQuery is not of this service

Compliance:

mandatory - This method must be implemented.