Interface OfferingSearchSession

All Superinterfaces:

AutoCloseable, Closeable, OfferingQuerySession, OsidSession, OsidSession

public interface OfferingSearchSession
extends OfferingQuerySession

This session provides methods for searching Offerings . 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 an 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

Modifier and Type	Method	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 Closeable

close

Methods inherited from interface OfferingQuerySession

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

Modifier and Type	Method	Description
boolean	canSearchOfferings()	Tests if this user can perform Offering searches.
Catalogue	getCatalogue()	Gets the Catalogue associated with this session.
Id	getCatalogueId()	Gets the Catalogue Id associated with this session.
OfferingQuery	getOfferingQuery()	Gets an offering query.
OfferingList	getOfferingsByQuery(OfferingQuery offeringQuery)	Gets a list of offerings matching the given offering query.
void	useFederatedCatalogueView()	Federates the view for methods in this session.
void	useIsolatedCatalogueView()	Isolates the view for methods in this session.

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

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.