org.osid.offering

Interface OfferingSearchSession

All Superinterfaces:

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

public interface OfferingSearchSession
extends OfferingQuerySession

This session provides methods for searching Offering objects. The search query is constructed using the OfferingQuery. The offering record Type also specifies the record for the offering query.

getOfferingsByQuery() is the basic search method and returns a list of Offering elements. A more advanced search may be performed with getOfferingsBySearch(). It accepts an OfferingSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getOfferingsBySearch() returns an OfferingSearchResults that can be used to access the resulting OfferingList or be used to perform a search within the result set through OfferingSearch.

This session defines views that offer differing behaviors for searching.

• federated catalogue view: searches include offerings in catalogues of which this catalogue is a ancestor in the catalogue hierarchy
• isolated catalogue view: searches are restricted to offerings in this catalogue

Offerings may have a query record indicated by their respective record types. The query record is accessed via the OfferingQuery. The returns in this session may not be cast directly to these interfaces.

Method Summary

Methods

Modifier and Type	Method and Description
OfferingQuery	getOfferingQueryFromInspector(OfferingQueryInspector offeringQueryInspector) Gets an offering query from an inspector.
OfferingSearchResults	getOfferingsBySearch(OfferingQuery offeringQuery, OfferingSearch offeringSearch) Gets the search results matching the given search.
OfferingSearch	getOfferingSearch() Gets an offering search.
OfferingSearchOrder	getOfferingSearchOrder() Gets an offering search order.

Methods inherited from interface org.osid.offering.OfferingQuerySession

canSearchOfferings, getCatalogue, getCatalogueId, getOfferingQuery, getOfferingsByQuery, useFederatedCatalogueView, useIsolatedCatalogueView

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

getOfferingSearch

OfferingSearch getOfferingSearch()

Gets an offering search.

Returns:

the offering search

Compliance:

mandatory - This method must be implemented.

getOfferingSearchOrder

OfferingSearchOrder getOfferingSearchOrder()

Gets an offering search order. The OfferingSearchOrder is supplied to an OfferingSearch to specify the ordering of results.

Returns:

the offering search order

Compliance:

mandatory - This method must be implemented.

getOfferingsBySearch

OfferingSearchResults getOfferingsBySearch(OfferingQuery offeringQuery,
                                         OfferingSearch offeringSearch)
                                           throws OperationFailedException,
                                                  PermissionDeniedException

Gets the search results matching the given search.

Parameters:

offeringQuery - the offering query

offeringSearch - the offering search

Returns:

the search results

Throws:

NullArgumentException - offeringQuery or offeringSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - offeringQuery or offeringSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getOfferingQueryFromInspector

OfferingQuery getOfferingQueryFromInspector(OfferingQueryInspector offeringQueryInspector)

Gets an offering query from an inspector. The inspector is available from an OfferingSearchResults.

Parameters:

offeringQueryInspector - an offering query inspector

Returns:

the offering query

Throws:

NullArgumentException - offeringQueryInspector is null

UnsupportedException - offeringQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.