org.osid.installation

Interface DepotSearchSession

All Superinterfaces:

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

public interface DepotSearchSession
extends DepotQuerySession

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

getDepotsByQuery() is the basic search method and returns a list of Depot objects.A more advanced search may be performed with getDepotsBySearch(). It accepts a DepotSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getDepotsBySearch() returns a DepotSearchResults that can be used to access the resulting DepotList or be used to perform a search within the result set through DepotSearch.

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
DepotQuery	getDepotQueryFromInspector(DepotQueryInspector depotQueryInspector) Gets a depot query from an inspector.
DepotSearchResults	getDepotsBySearch(DepotQuery depotQuery, DepotSearch depotSearch) Gets the search results matching the given search query using the given search.
DepotSearch	getDepotSearch() Gets a depot search.
DepotSearchOrder	getDepotSearchOrder() Gets a depot search order.

Methods inherited from interface org.osid.installation.DepotQuerySession

canSearchDepots, getDepotQuery, getDepotsByQuery

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

getDepotSearch

DepotSearch getDepotSearch()

Gets a depot search.

Returns:

a depot search

Compliance:

mandatory - This method must be implemented.

getDepotSearchOrder

DepotSearchOrder getDepotSearchOrder()

Gets a depot search order. The DepotSearchOrder is supplied to a DepotSearch to specify the ordering of results.

Returns:

the depot search order

Compliance:

mandatory - This method must be implemented.

getDepotsBySearch

DepotSearchResults getDepotsBySearch(DepotQuery depotQuery,
                                   DepotSearch depotSearch)
                                     throws OperationFailedException,
                                            PermissionDeniedException

Gets the search results matching the given search query using the given search.

Parameters:

depotQuery - the depot query

depotSearch - the depot search

Returns:

the depot search results

Throws:

NullArgumentException - depotQuery or depotSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - depotQuery or depotSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getDepotQueryFromInspector

DepotQuery getDepotQueryFromInspector(DepotQueryInspector depotQueryInspector)

Gets a depot query from an inspector. The inspector is available from a DepotSearchResults.

Parameters:

depotQueryInspector - a depot query inspector

Returns:

the depot query

Throws:

NullArgumentException - depotQueryInspector is null

UnsupportedException - depotQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.